Bureaucrats, confirmed, Administrators
4,558
edits
Changes
adds local resources
== Documenting other languages ==
Aside from the Python-specific PyDoc, there are [http://www.xs4all.nl/~rfsber/Robo/robodoc.html ROBODoc] (Windows and Fink) and [http://www.stack.nl/~dimitri/doxygen Doxygen] tools which should prove to meet all needs. For doxygen, you can
<source lang="bash">
sudo apt-get install doxygen-gui doxygen doxygen-doc
== Programming APIs ==
SWIG [[wp:Swig]] ([http://www.swig.org/exec.html Executive Summary]) helps application developers reveal an API. Several open source projects leverage SWIG, such as Subversion, wxPython and wxWindows. In turn, other developers can enhance these generic APIs to customize them for a particular programming language. For example Python developers can use [http://pysvn.tigris.org/docs/pysvn_prog_guide.html pySVN] while work is underway to expand the PHP interface. See more in the Subversion manual http://svnbook.red-bean.com/nightly/en/svn-book.html#svn.developer.usingapi
== Resources ==
* http://gotapi.com publishes several API references for everything from HTML and CSS to DocBook and Drupal. This organized list of API references also features fast, as-you-type search. * Create your own internal-use API Documentation by creating a symbolic link from /usr/share/docs to /var/www/docs
* Some other documentation resources:
** [http://svn.wikimedia.org/doc/ MediaWiki Doxygen docs]
** http://api.kde.org/ APIs of the K Desktop Environment
** http://doc.trolltech.com/ APIs of the Qt GUI Toolkit
== Local Resources ==
These tips may not be strictly "API" documents, but they do reveal man pages, howtos, and other help; plus programmatic interfaces.
* Create your own internal-use API Documentation by creating a symbolic link from /usr/share/docs to /var/www/docs
* info:/dir (type this into the location bar of Konqueror) browse the Info system. You can of course type "info" in your shell, but I find that browsing "info" through Konqueror is a lot nicer.
* man:/command (type this into the location bar of Konqueror) browse the Man system. You can of course type "man command" in your shell, but I find that browsing "manuals" through Konqueror is a lot nicer.
[[Category:Applications]]