Input used in their production they are not affected by this license. It is provided "as is" without express or implied warranty.ĭocuments produced by doxygen are derivative works derived from the No representations are made about the suitability of this softwareįor any purpose. Permission to use, copy, modify, and distribute this software and itsĭocumentation under the terms of the GNU General Public License is hereby Furthermore, executables for Windows are available. Some further points to consider: Doxygen does accept the see (which is synonymous to sa) and link commands. To link to an all lower case symbol, use ref. As a result, it runs on most other Unix flavors as well. If you want to prevent that a word that corresponds to a documented class is replaced by a link you should put a in front of the word. You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site).ĭoxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. Doxygen can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically. This is very useful to quickly find your way in large source distributions. You can configure doxygen to extract the code structure from undocumented source files. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. Doxygen also supports the hardware description language VHDL. Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |