![]() As an example, the default style + sheet generated by doxygen has an example. Additional (ccross)Ĭompile build environments can be specified in a seperate. 2) Add doxygen templates and configuration file 3) Modify docs/Makefile to call. cpp files, though Doxygen won’t use them extensively. But, you should still comment code in your. The comments are included in the header files (.h) files. Doxygen supports various styles of formatting your comments. In this section we look at the contents of the comment block itself. To use Doxygen, you write comments in code using the format that Doxygen understands. The previous section focused on how to make the comments in your code known to doxygen, it explained the difference between a brief and a detailed description, and the use of structural commands. compilers, makefile-, cmake-,Įclipse-, codeblocks- and msdev exporters, cppcheck source code checking, doxygenĭocumentation creation will be available for each build variant. Birds-eye view of how Doxygen works There are two main steps in using Doxygen: 1. native or cross-Ĭompile) will be loaded and configured as well e.g. Required C/C++ tools for each build environment variant (i.e. When loading and configuring the ccenv tool, as shown in the example above, all lower () class _t ( ctx ): _doc_ = " %s s ' %s '" % ( name, var ) cmd = name + '_' + var variant = var build ( bld, trees = ) for var in ccenv. load ( 'ccenv' ) def build ( bld ): ccenv. replace ( ' \\ ', '/' ) VERSION = '0.0.1' APPNAME = 'example' def options ( opt ): opt. #!/usr/bin/env python # -*- encoding: utf-8 -*- import os, waftools from waftools import ccenv top = '.' out = 'build' ini = os.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |