Last modified: 2014-05-08 23:05:59 UTC

Wikimedia Bugzilla is closed!

Wikimedia has migrated from Bugzilla to Phabricator. Bug reports should be created and updated in Wikimedia Phabricator instead. Please create an account in Phabricator and add your Bugzilla email address to it.
Wikimedia Bugzilla is read-only. If you try to edit or create any bug report in Bugzilla you will be shown an intentional error message.
In order to access the Phabricator task corresponding to a Bugzilla report, just remove "static-" from its URL.
You could still run searches in Bugzilla or access your list of votes but bug reports will obviously not be up-to-date in Bugzilla.
Bug 64996 - Doxygen documentation of Wikibase code
Doxygen documentation of Wikibase code
Status: NEW
Product: MediaWiki extensions
Classification: Unclassified
WikidataRepo (Other open bugs)
unspecified
All All
: Normal enhancement (vote)
: ---
Assigned To: Wikidata bugs
u=dev c=infrastructure p=0
:
Depends on:
Blocks: documentation
  Show dependency treegraph
 
Reported: 2014-05-07 10:05 UTC by tobias.gritschacher
Modified: 2014-05-08 23:05 UTC (History)
1 user (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description tobias.gritschacher 2014-05-07 10:05:08 UTC
Generate doxygen documentation and put it on e.g. docs.wikiba.se and link to it from our other documentations.
Comment 1 Thiemo Mättig 2014-05-07 10:18:26 UTC
http://docs.wikiba.se/ sounds good. Maybe a structure like
http://docs.wikiba.se/repo/0.5/php/
http://docs.wikiba.se/repo/0.5/js/
http://docs.wikiba.se/client/0.5/php/
http://docs.wikiba.se/client/0.5/js/

Not sure if the php/js separation is needed. Is Doxygen able to process both in a single documentation?

If this is done please create a redirect from http://wikidata-docs.wikimedia.de/ to the new location.
Comment 2 Christopher Johnson 2014-05-07 18:31:14 UTC
For reference, core doxygen docs are here:
https://doc.wikimedia.org/mediawiki-core/master/php/html/index.html
No JS in these docs though.  This is shown on the sidebar on https://www.mediawiki.org/ as "Code docs".  

The JS could be filtered with a second tool, like http://svn.berlios.de/wsvn/jsunit/trunk/jsunit/util/js2doxy.pl?op=file&rev=0&sc=0 described here http://jsunit.berlios.de/internal.html (assuming it is documented per Javadoc conventions).
Comment 3 Christopher Johnson 2014-05-07 23:39:55 UTC
Note that WB code has not yet implemented doc groups/modules (unlike core).
See http://www.stack.nl/~dimitri/doxygen/manual/grouping.html

May want to consider adding this rather than splitting up into separate doc builds.

See http://wbdoc.wmflabs.org/ for bundled Wikibase build documentation test. 

Check http://wbdoc.wmflabs.org/doxygen.log for warnings.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links