- #Doxygen special commands how to
- #Doxygen special commands mac os x
- #Doxygen special commands install
- #Doxygen special commands manual
The second part forms a reference manual: Section Troubleshooting tells you what to do when you have problems. Section Frequently Asked Questions gives answers to frequently asked questions.
#Doxygen special commands how to
Section Linking to external documentation explains how to let doxygen create links to externally generated documentation. Section Preprocessing explains how doxygen deals with macro definitions. Section Graphs and diagrams describes the diagrams and graphs that doxygen can generate. Section Including formulas shows how to insert formulas in the documentation. Section Grouping shows how to group things together. Section Lists show various ways to create lists. Section Documenting the code demonstrates the various ways that code can be documented. Section Getting started tells you how to generate your first piece of documentation quickly.
#Doxygen special commands install
Section Installation discusses how to download, compile and install doxygen for your platform.
#Doxygen special commands manual
This manual is divided into three parts, each of which is divided into several sections.
#Doxygen special commands mac os x
Furthermore, executables for Windows 9x/NT and Mac OS X are available. As a result, it runs on most other Unix flavors as well. You can even `abuse' doxygen for creating normal documentation (as I did for this manual).ĭoxygen is developed under Linux, but is set-up to be highly portable.
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. 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. You probably want to use doxygen's \c and \# special commands to provide code formatting for the next word: Use \c \#define for something.Doxygen is a documentation system for C++, C, Java, IDL (Corba and Microsoft flavors) and to some extent PHP and C#. The \c command operates on the string "#foo bar", and that string is not interpolated. The character " is a special character in doxygen. Use \c and **do not* backslash escape the hash symbol: /*! (i.e., #foo along with bar are in a monospaced font, along with the double quotes that surround #foo bar). (i.e., #foo along with bar is in a monospaced font, and are not double quoted). Simply escape the hash symbol in the doxygen commentary: /*!
(i.e., #foo is not in a monospaced font). If stuff is simple, you'll be okay, but you're better off using something else if it contains any special doxygen characters. Doxygen proper does not see the backslash as escaping the pound symbol when used in markdown code span.īe very careful using `stuff` in doxygen. Writing `"\#include foo"` doesn't work, either. Doxygen tries to process that #include as a refering to some entity named include. It doesn't there's some undocumented interaction between doxygen-flavored markdown and the rest of doxygen. That doxygen supports markdown suggests that simply writing `"#include foo"` in the code should do the trick. I wanted to see "#include foo" (quoted and in a monospaced font) rather that #define in the generated documentation. I ran across a similar warning but in a slightly different context.
0 kommentar(er)
