Documenting applet config keys
Aleix Pol
aleixpol at kde.org
Mon Sep 12 18:50:28 UTC 2016
On Thu, Sep 8, 2016 at 3:15 PM, David Edmundson
<david at davidedmundson.co.uk> wrote:
> For scripting purposes it's important to know the configuration keys of an
> applet/wallapper/containment .
>
> Currently this is written into the wiki, which isn't a good way to do
> documentation, it gets out of sync.
>
> I wrote a script that reads kcfg xml files and autogenerates the docs for
> the wiki.
> (Martin G has an idea to put it into api.kde.org, which I think is a good
> future direction)
>
> The documentation here [1]: is now completely up-to-date \o/
>
> However, the state of descriptions still sucks. Can people please start to
> fill out <label> tags inside the entries in all applet main.xml config
> files. Also please add hidden=true if they should not be listed here. [2]
>
> Thanks
>
> [1]https://userbase.kde.org/KDE_System_Administration/PlasmaDesktopScripting#Configuration_Keys
>
> [2] https://www.kde.org/standards/kcfg/1.0/kcfg.xsd
>
Is there any way we can work on making sure there's no regressions?
I'm thinking of something like this:
https://quickgit.kde.org/?p=extra-cmake-modules.git&a=commit&h=47d580f9de23ef1ef5e71f054ea893b23702e097
Aleix
More information about the Plasma-devel
mailing list