Changes between Version 11 and Version 12 of Developer/Coding/Doxygen


Ignore:
Timestamp:
Dec 15, 2012, 7:25:17 PM (7 years ago)
Author:
Gedare
Comment:

/* Files */

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Doxygen

    v11 v12  
    271271=  Files  =
    272272
    273 You can document a file with the ''@file [filename]'' directive. If you omit the filename Doxygen will use it for the documentation of the file containing this directive.  This is the preferred way to document files which can be read by Doxygen. You should not use ''@file name_of_current_file'' to document the current file because this instructs Doxygen to document a file with the filename ''name_of_current_file'' and this is not necessarily the current one and may lead to ambiguity if someone from outside reuses your stuff to generate her documentation. Within one Doxygen run all files are unique and specified by the current Doxyfile. You can define how the generated output of path and filenames looks like in the Doxyfile via the
    274 FULL_PATH_NAMES, STRIP_FROM_PATH and STRIP_FROM_INC_PATH options.
     273Document files with the ''@file'' directive omitting the optional filename argument. Doxygen will infer the filename from the actual name of the file. Within one Doxygen run all files are unique and specified by the current Doxyfile. We can define how the generated output of path and filenames looks like in the Doxyfile via the FULL_PATH_NAMES, STRIP_FROM_PATH and STRIP_FROM_INC_PATH options.
    275274=  Functions  =
    276275