Bureaucrats, confirmed, Administrators
4,558
edits
Changes
adds section on JavaScript (JSDuck)
== Documenting PHP Code ==
The main resource is the [http://www.phpdoc.org Project website], including tutorials and full Documentation. The system can be installed via the PEAR installer, but should not be setup in an Internet-facing environment. See the [[PhpDocumentor]] article for details on our installation and usage.
== Documenting JavaScript ==
JSDuck is an open source ExtJS 4 project developed at Sencha to help Javascript developers generate beautiful documentation viewable in a web browser. Based loosely on JavaDoc, JSDuck parses documentation embedded in the source files of your project enabling you to keep your docs close to your code. In this session we will cover the many features of JSDuck and by the end you will know how to create API documentation, guides, videos and examples for your own project or application.
* [https://vimeo.com/33465319 watch]
* Example: the MediaWiki project uses jsduck to generate https://doc.wikimedia.org/mediawiki-core/master/js/
* Example: https://docs.sencha.com/extjs/6.0.2-modern/
* More recently, Sencha has started using a custom documentation generator based on https://github.com/evindor/doxi <ref>https://www.sencha.com/forum/showthread.php?311056-documentation-system-to-use-for-ext-js-6.0.2-jsduck-still</ref>
== Documenting other languages ==
OK, so you've adopted all kinds of tools, and procedures for documentation, and you've got multiple people actually writing or contributing to your project's documentation... Great! That means you need some documentation about how you document things :-) Examples:
* http://www.open-emr.org/wiki/index.php/How_to_Document_Your_Code_Properly
{{References}}
[[Category:Applications]]