Last modified: 2014-03-14 11:51:40 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T42657, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 40657 - Auto-generated documentation for JavaScript code based on already existing doxygen comments
Auto-generated documentation for JavaScript code based on already existing do...
Status: NEW
Product: MediaWiki extensions
Classification: Unclassified
WikidataRepo (Other open bugs)
unspecified
All All
: Low minor (vote)
: ---
Assigned To: Wikidata bugs
: need-volunteer
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2012-10-01 10:42 UTC by Daniel A. R. Werner
Modified: 2014-03-14 11:51 UTC (History)
8 users (show)

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


Attachments

Description Daniel A. R. Werner 2012-10-01 10:42:40 UTC
Right now we only generate a documentation for PHP code. This can be found here:
http://wikidata-docs.wikimedia.de/

It would be nice to have the same for JavaScript code if this is possible somehow.
Comment 1 abraham.taherivand 2012-10-11 09:56:02 UTC
see: http://www.stack.nl/~dimitri/doxygen/helpers.html
Comment 2 Anja Jentzsch 2012-10-23 11:50:53 UTC
Decided on this method: http://xiewenjie.com/doxygen-js/use-doxygen-to-document-javascript
Comment 3 Daniel Friesen 2012-11-07 17:56:55 UTC
I see no reason to mark this RESOLVED LATER. If it's not going to be done now, lower the priority.
Comment 4 Anja Jentzsch 2012-11-07 18:19:08 UTC
This is the Wikidata bug, the WMF one is over here: https://bugzilla.wikimedia.org/show_bug.cgi?id=40143

For Wikidata we set up a script that converts .js to .cpp files [1]. We had to adjust parameter names to match the WM coding conventions [2].
But the JS parser fails to parse our prototype definitions, so classes and their hierarchy are not recognized.

We will come back to this later.

[1] http://xiewenjie.com/doxygen-js/use-doxygen-to-document-javascript
[2] http://www.mediawiki.org/wiki/Manual:Coding_conventions/JavaScript#Documentation_comments
Comment 5 Andre Klapper 2012-12-12 13:16:28 UTC
[Removing RESOLVED LATER as discussed in http://lists.wikimedia.org/pipermail/wikitech-l/2012-November/064240.html . Reopening and setting priority to "Lowest" as discussed on IRC.
For future reference, please use either RESOLVED WONTFIX (for issues that will not be fixed), or simply set lowest priority. Thanks a lot!]

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


Navigation
Links