doc/gbuild/doxygen.cfg

23 # This file describes the settings to be used by the documentation system
51 # This could be handy for archiving the generated documentation or
57 # base path where the generated documentation will be put.
73 # documentation generated by doxygen is written. Doxygen will use this
87 # the file and class documentation (similar to JavaDoc).
118 # inherited members of a class in the documentation of that class as if those
140 # the path mentioned in the documentation of a class, which tells
179 # member inherits the documentation from any documented member that it
185 # a new page for each member. If set to NO, the documentation of a member will
196 # as commands in the documentation. An alias has the form "name=value".
198 # put the command \sideeffect (or @sideeffect) in the documentation, which
264 # documentation. This will only work if the methods are indeed getting or
270 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
271 # tag is set to YES, then doxygen will reuse the documentation of the first
287 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
316 # documentation are documented, even if no documentation was available.
323 # will be included in the documentation.
328 # will be included in the documentation.
333 # defined locally in source files will be included in the documentation.
340 # the interface are included in the documentation.
346 # extracted and appear in the documentation as a namespace called
356 # various overviews, but no documentation section is generated.
371 # documentation.
376 # documentation blocks found inside the body of a function.
378 # function's detailed documentation block.
382 # The INTERNAL_DOCS tag determines if documentation
384 # to NO (the default) then the documentation will be excluded.
385 # Set it to YES to include the internal documentation.
399 # documentation. If set to YES the scope will be hidden.
404 # will put a list of the files that are included by a file in the documentation
410 # is inserted in the documentation for inline members.
415 # will sort the (detailed) documentation of file and class members
422 # brief documentation of file, namespace and class members alphabetically
446 # commands in the documentation.
452 # commands in the documentation.
458 # commands in the documentation.
464 # \deprecated commands in the documentation.
469 # documentation sections, marked by \if sectionname ... \endif.
475 # the documentation. If the initializer consists of more lines than specified
478 # documentation can be controlled using \showinitializer or \hideinitializer
479 # command in the documentation regardless of this setting.
484 # at the bottom of the documentation of classes and structs. If set to YES the
485 # list will mention the files that were used to generate the documentation.
491 # in the documentation. The default is NO.
549 # potential errors in the documentation, such as not documenting some
556 # functions that are documented, but have no documentation for their parameters
558 # wrong or incomplete parameter documentation, but not about the absence of
559 # documentation.
661 # directories that contain image that are included in the documentation (see
706 # of functions and classes directly in the documentation.
732 # Otherwise they will link to the documentation.
822 # documentation will contain sections that can be hidden and shown after the
832 # To create a documentation set, doxygen will generate a Makefile in the
842 # feed. A documentation feed provides an umbrella under which multiple
843 # documentation sets from a single provider (such as a company or product suite)
849 # should uniquely identify the documentation set bundle. This should be a
858 # of the generated HTML documentation.
895 # to the contents of the HTML help documentation and to the tree view.
902 # HTML documentation.
955 # that doxygen will group on one line in the generated HTML documentation.
983 # as images in the HTML documentation. The default is 10. Note that
1049 # higher quality PDF documentation.
1142 # the code including all documentation.
1178 # documentation. Note that this feature is still experimental
1189 # the code including all documentation. Note that this
1289 # Optionally an initial location of the external documentation
1345 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1471 # contain dot files that are included in the documentation (see the