Doxygen
Doxygen (ドキシジェン) is C++, C language, JAVA, Objective-C, Python, a documentation generator for IDL (CORBA and Microsoft formality). Besides, it is available to some extent in PHP, C#, D language, ActionScript. I work in many Unix system systems, Windows, macOS. Dimitri van Heesch wrote most of the cords of Doxygen.
Origin of development | Dimitri van Heesch |
---|---|
The latest edition | 1.8.12 / 2016May 9 |
Repository | https://github.com/doxygen/doxygen, git://github.com/doxygen/doxygen.git |
The correspondence OS | GNU/Linux, Windows, macOS, Solaris |
Classification | Documentation generator |
License | GNU General Public License |
Official site | http://www.doxygen.org/ |
KDE uses Doxygen in a part of the document, and KDevelop supports it including a composing type.
Table of contents
Summary
Like Javadoc, Doxygen pulls out a document from the comment of the source file. In addition to grammar of Javadoc, I support a documentation tag used with Qt tool kit and can generate not only the HTML form but also CHM, RTF, PDF, LaTeX, PostScript, the document of the man page form.
Example code
The following example codes are the procedures that document generation is available for in Doxygen.
/** * The time class represents a moment of time. * * \author John Doe */ class Time { /** * Constructor that sets the time to a given value. * \param timemillis is a number of milliseconds passed since Jan 1. 1970 */ Time(int timemillis) { ... } /** * Get the current time. * \return A time object set to the current time. */ static Time now() { ... } },
Allied item
- Software documentation
- Eclox : Doxygen front end free software plug in for Eclipse. It is licensed in GNU General Public License.
- Graphviz : Doxygen can generate class hierarchy figures in cooperation with GraphViz about C++, JAVA, Python.
Outside link
- Sourceforge homepage
- I make it in MediaWiki documentation Doxygen
This article is taken from the Japanese Wikipedia Doxygen
This article is distributed by cc-by-sa or GFDL license in accordance with the provisions of Wikipedia.
In addition, Tranpedia is simply not responsible for any show is only by translating the writings of foreign licenses that are compatible with CC-BY-SA license information.
0 개의 댓글:
댓글 쓰기