Doxygens tags are words preceeded by either a backslash * or by an at symbol * * */ #ifndef _BOX_PROTOTYPES_DOXYGEN_H # define _BOX_PROTOTYPES_DOXYGEN_H # include # include # include # include # include "local_header1.h" # include "local_header2.h" /** * Use brief, otherwise the index won't have a brief explanation. * * Here typically goes a more extensive explanation of what the header * defines. ''' def func (): '''Documentation for a function. You can either use the Python documentation string syntax: '''package docstring Documentation for this module. Due to these advantages, developers are now. Moreover, it can cross-reference the code and documentation, which helps in referring to the actual code. As it is written within the code, it is very easy to keep on updating.
* * * * You should have received a copy of the GNU Lesser General Public * * License along with Box. Doxygen is a tool or command line-based documentation generator that helps in writing reference documentation for software. Doxygen also supports the hardware description language VHDL. See the * * GNU Lesser General Public License for more details. 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.
* * * * Box is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Viewed 180 times -1 I recently started using doxygen with clion.
The following Makefile rules run Doxygen to generate HTML docs, XML docs.
* * * * Box is free software: you can redistribute it and/or modify it * * under the terms of the GNU Lesser General Public License as published * * by the Free Software Foundation, either version 3 of the License, or * * (at your option) any later version. Documentation for the GNU C++ Library is created from three independent.
I'd also like to have these documented, but no matter what I try, Doxygen will not generate documentation from the comments that I have placed above the functions. **************************************************************************** * Copyright (C) 2012 by Matteo Franchin * * * * This file is part of Box. By writing documentation blocks for all public or protected C++ components (namespaces, types, methods, functions, and constants). The documentation of the classes is fine, but I've also got some non-member functions that I use to create objects etc.