Doxygen project is a documentation system for C , C, Java, Objective-C, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D.
Product's homepage
Here are some key features of "Doxygen":
· It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $mbox{LaTeX}$ ) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages.The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
· You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You 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.
· You can even `abuse' doxygen for creating normal documentation (as I did for this manual).
· Doxygen is developed under Linux and Mac OS X, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well.
What's New in This Release: [ read full changelog ]
Changes:
· Auto list items can now consist of multiple paragraphs. The indentation of the (first line) of a new paragraph detemines to which list item the paragraph belongs or if it marks the end of the list.
· When UML_LOOK is enabled, relations shown on the edge of a graph are not shown as attributes (conform to the UML notation)
· Updated the manual and improved the look.
· Made the contents in the navigation tree more consistent for groups, pages with subpages, and grouped subpages.
· id 669079: Latex: made the margins of latex page layout smaller using the geometry package.
· The tool doxytag has been declared obsolete and is removed (it wasn't working properly anyway). Same goes for the installdox script.
· Updated the copyright in source code and doxywizard "about" to 2012.
· id 668008: HTML version of the manual now has the treeview enabled for easier navigation.
New features:
Added support for Markdown formatting. This is enabled by default, but can be disabled by setting MARKDOWN_SUPPORT to NO. When enabled the following is processed differently:
· tabs are converted to spaces according to TAB_SIZE.
· blockquotes are created for lines that start with one or more >'s (amount of >'s detemine the indentation level).
· emphasis using *emphasize this* or _emphasis this_ or strong emphasis using **emphasis this**. Unlike classic Markdown 'some_great_indentifier' is not touched.
· code spans can be created using back-ticks, i.e. `here's an example`
· Using three or more -'s or *'s alone on a line with only spaces will produce a horizontal ruler.
· A header can be created by putting a ===== (for h1) or ----- (for h2) on the next line or by using 1 to 6 #'s at the start of a line for h1-h6.
· auto lists item can also start with + or * instead of only -
· ordered lists can be made using 1. 2. ... labels.
· verbatim blocks can be produced by indenting 4 additional spaces. Note that doxygen uses a relative indent of 4 spaces, not an absolute indent like Markdown does.
· Markdown style hyperlinks and hyperlink references.
· Simple tables can be created using the Markdown Extra format.
· Fenced code blocks are also supported, include language selection.
· files with extension .md or .markdown are converted to related pages.
· See the section about Markdown support in the manual for details.
· It is now possible to add user defined tabs or groups of tabs to the navigation menu using the layout file (see the section of the manual about customizing the output for details).
· Added new command \tableofcontents (or [TOC] if you prefer Markdown) which can be used in a related page with sections to produce a table of contents at the top of the HTML page (for other formats the command has no effect).
· When using SVG images and INTERACTIVE_SVG is enabled, a print icon will be visible along with the navigation controls to facilitate printing of the part of the graph that is visible on screen.
· Added obfuscation of email addresses for the HTML output to make email harvesting more difficult.
· Added build targets for 64 bit Windows (thanks to Vladimir Simonov). The installer script is also updated to install a 64 bit version of doxygen on 64 bit systems and the 32 bit version on 32 bit systems.
· Added support for using the HTML tag in comments.
· Included patch by Gauthier Haderer that fixes some issues with the dbus XML parser.
· Added support for Markdown style fenced code blocks.
· Added option to @code command to force parsing and syntax highlighting according to a particular language.
· Section of pages are now added to the navigation index.
· Added support for cell alignment and table header shading in LaTeX and RTF output.
· Added -d filteroutput option to show the output of an input filter (thanks to Albert for the patch).
· id 668010: Latex: for Windows doxygen new generates a makepdf.bat file in the latex output dir to create the latex documentation.
Bug fixes (ids refer to the bugzilla database):
· id 498703: Fixed encoding issue in CHM index file for group titles.
· id 510975: FORTRAN: Keywords like .GT. recognized as symbols for cross ref.
· id 511906, 581303, 622749: \copydoc did copy the brief description into the detailed section, causing a difference between the original and the copy.
· id 555327: Using @ref for an example file, caused it to appear as file::ext.
· id 567494: Fortran: Included patch for blockdata sub-programs.
· id 628417: Fortran: doxygen filter, preparsing fixed form of null
· id 662286: TCL: Inlcuded patch to fixed UTF-8 support.
· id 662289: TCL: Included patch to prevent ##### from appearing in the output.
· id 646319: Using a file name with path for HTML_STYLESHEET caused the path to appear in the HTML output.
· id 664826: Fixed one more problem with include guard detection.
· id 665629: Fixed parse problem when a #define appeared inside an enum.
· id 665855: Fixed problem parsing C++ template specialization of the form A such as used in boost::signal2 types.
· id 666047: A followed by an \htmlonly..\endhtmlonly section caused invalid XHTML output.
· id 666085: Fixed include handling in case the include guard was documented.
· id 666124: Fixed problem loading the navigation tree in IE8 when serving pages via a web server.
· id 666337: Included patch to avoid hypenation hints in front of the first captial in a word.
· id 666568: When SHOW_FILES was NO, a grouped function did not appear in the javascript based search index.
· id 666909: \copybrief introduced extra spacing in the HTML output.
· id 666986: Fixed case where search engine specific code appeared twice in the HTML output.
· id 666993: Fixed bug in the generated makefile causing index not to be generated when using pdflatex.
· id 667020: HTML output for example pages was not well-formed.
· id 667192: Include statements in latex output where placed all on one line in the LaTeX output.
· id 667835: PHP: Fixed problem handling heredoc blocks
· id 667844: For aliases with a single argument it is no longer required to escape commas that appear inside the argument text.
· id 668037: Latex: tables can now span multiple pages by using the xtab package.
· id 668218: Doxygen will ignore the common prefix shared by all directories when computing a names for the directory's output files. This will make the names of the output more stable.
· id 668519: Added missing newline in man page output.
· id 669071, 669072: Fixed parse problem for Q_PROPERTY when a template with a namespaced type was used.
· id 669078: Included patch which changes MATHJAX_RELPATH to use the content delivery network by default.
· id 669138: Fortran: Fixed problem handling multiple definition statements on one line.
· id 669406: Using -d Preprocessor now also works when QUIET is YES.
· id 669434: Latex: citations where only generated properly if the bib files specified via CITE_BIB_FILES did not have a path.
· id 669758: Tcl: Same function in multiple Tcl namespaces not added.
· id 670289: Fixed case where doxygen would not correctly detect >> as a termination of a nested template.
· id 670571: subpages generate empty pages in latex/rtf output and broken links when SHORT_NAME was set to YES.
· Included VHDL fixes provided by Martin Kreis.
· The word "dummy" wrongly appeared before the first parameter type in the LaTeX output for an Objective-C method.
· Fixed several small glitches in the tree view javascript code.
· Included a patch by Vladimir Simonov to make it possible to compile doxygen with Visual Studio 2005.
· Fixed some typos in the manual (thanks Albert).
Find us on Google+
