- DOXYGEN COPYRIGHT TAG HOW TO
- DOXYGEN COPYRIGHT TAG INSTALL
- DOXYGEN COPYRIGHT TAG SOFTWARE
- DOXYGEN COPYRIGHT TAG CODE
- DOXYGEN COPYRIGHT TAG LICENSE
You can also submit enhancement requests in the bug tracker. Future workĪlthough doxygen is successfully used by large number of companies and open source projects already, there is always room for improvement. If you know other projects, let me know and I'll add them. These are part of a larger list of projects that use doxygen. I've gathered some nice examples of real-life projects using doxygen. User examplesĭoxygen supports a number of output formats where HTML is the most popular one.
DOXYGEN COPYRIGHT TAG LICENSE
See the GNU General Public License for more details.ĭocuments produced by doxygen are derivative works derived from the input used in their production they are not affected by this license. It is provided "as is" without express or implied warranty.
DOXYGEN COPYRIGHT TAG SOFTWARE
No representations are made about the suitability of this software for any purpose. Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted.
DOXYGEN COPYRIGHT TAG HOW TO
Section Internationalization explains how to add support for new output languages.Ĭopyright © 1997-2022 by Dimitri van Heesch. Section Perl Module Output shows how to use the PerlMod output. Section Doxygen's Internals gives a global overview of how doxygen is internally structured. The third part provides information for developers: Section Emoji support shows an introduction how emoji can be used within the documentation. Section XML Commands shows an overview of the C# style XML commands that can be used within the documentation. Section HTML Commands shows an overview of the HTML commands that can be used within the documentation. Section Special Commands shows an overview of the special commands that can be used within the documentation. Section Configuration shows how to fine-tune doxygen, so it generates the documentation you want. Section Doxywizard usage shows how to use the doxywizard program. Section Doxygen usage shows how to use the doxygen program. Section Features presents an overview of what doxygen can do. 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.
Section Linking to external documentation explains how to let doxygen create links to externally generated documentation. Section Custom Commands show how to define and use custom commands in your comments. Section Customizing the output explains how you can customize the output generated by doxygen. Section External Indexing and Searching shows how use the external search and index tools Section Searching shows various ways to search in the HTML documentation. Section Output Formats shows how to generate the various output formats supported by doxygen. Section Automatic link generation shows how to put links to files, classes, and members in the 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 Including tables shows how to insert tables in the documentation. Section Grouping shows how to group things together. Section Markdown support show the Markdown formatting supported by doxygen.
DOXYGEN COPYRIGHT TAG CODE
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 COPYRIGHT TAG INSTALL
It also provides Satisfies requirement and Verifies requirements sections in the class description (or function - wherever you put the tag).Section Installation discusses how to download, compile and install doxygen for your platform. This gives me related pages for Requirements, Requirements Implementation, and Requirements Verification. * */Ĭlass Scheduler_ut : public CppUnit::TestFixture * */Īnd in my tests I put: /** * Provide a number of tests for process scheduling. In my code I have: /** * This is the basic executive that schedules processes. One could also put the text of the requirement in the anchor tag if you didn't need to link to an external source. Then I create a file called Requirements.dox that provides a link between the requirement id and a URL for the requirement in my requirements management tool (an issue tracker in my case). Where SRTX is the name of my project and is used as a prefix to requirements. The text below goes into my Doxyfile: ALIASES += req="\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1" Thanks mouviciel! I have adopted your solution and extended it for my purposes.