Bug 297640 - Document global JavaScript methods in KWin Scripting API documentation
Summary: Document global JavaScript methods in KWin Scripting API documentation
Status: RESOLVED FIXED
Alias: None
Product: kwin
Classification: Plasma
Component: scripting (show other bugs)
Version: git master
Platform: unspecified Linux
: NOR task
Target Milestone: 4.9
Assignee: KWin default assignee
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-04-07 08:01 UTC by Martin Flöser
Modified: 2012-04-10 18:45 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In: 4.9.0


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Flöser 2012-04-07 08:01:24 UTC
The KWin Scripting API documentation [1] is currently generated from Doxygen XML files and converted to MediaWiki with an XSLT.

This means that the global JavaScript methods are not documented at all. A possible solution would be to generate a matching XML document for the global methods.

[1] http://techbase.kde.org/Development/Tutorials/KWin/Scripting/API_4.9
Comment 1 Martin Flöser 2012-04-10 18:45:49 UTC
Git commit 71f86d7a4ac8c7c9d90e6df976303fb1f84959f5 by Martin Gräßlin.
Committed on 10/04/2012 at 20:41.
Pushed by graesslin into branch 'master'.

Documentation for global JavaScript methods/properties

The documentation is in an XML file which mimics the
XML output of doxygen, which can be converted to
MediaWiki syntax with the tools found in
kde:scratch/graesslin/kwin-scripting-api-generator git
repository.
FIXED-IN: 4.9.0

A  +54   -0    kwin/scripting/documentation-global.xml

http://commits.kde.org/kde-workspace/71f86d7a4ac8c7c9d90e6df976303fb1f84959f5