diff options
Diffstat (limited to 'doc/starting.doc')
| -rw-r--r-- | doc/starting.doc | 86 |
1 files changed, 49 insertions, 37 deletions
diff --git a/doc/starting.doc b/doc/starting.doc index e89f717..293f6b2 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -20,7 +20,7 @@ generates the documentation. See section \ref doxygen_usage for more detailed usage information. The executable \c doxytag is only needed if you want to generate references -to external documentation (i.e. documentation that was generated by Doxygen) +to external documentation (i.e. documentation that was generated by doxygen) for which you do not have the sources or to create a search index for the search engine. See section \ref doxytag_usage for more detailed usage information. @@ -35,7 +35,7 @@ Each project should get its own configuration file. A project can consist of a single source file, but can also be an entire source tree that is recursively scanned. -To simplify the creation of a configuration file, Doxygen can create a +To simplify the creation of a configuration file, doxygen can create a template configuration file for you. To do this call \c doxygen with the \c -g option: @@ -44,8 +44,10 @@ doxygen -g <config-file> \endverbatim where \<config-file\> is the name of the configuration file. If you omit the file name, a file named \c Doxyfile will be created. If a file with the -name \<config-file\> already exists, Doxygen will rename it to +name \<config-file\> already exists, doxygen will rename it to \<config-file\>.bak before generating the configuration template. +If you use <code>-</code> as the file name then doxygen will try to read +the configuration file from standard input (<code>stdin</code>). The configuration file has a format that is similar to that of a (simple) Makefile. It contains of a number of assignments (tags) of the form: @@ -53,7 +55,8 @@ Makefile. It contains of a number of assignments (tags) of the form: <tt>TAGNAME = VALUE</tt> or <br> <tt>TAGNAME = VALUE1 VALUE2 ... </tt><br> -You can probably leave the values of most tags to their default value. +You can probably leave the values of most tags in a generated template +configuration file to their default value. The \c INPUT tag is the only tag for which you are required to provide a value. See section \ref config for more details about the configuration file. @@ -62,20 +65,25 @@ you can add the names of the files after the \c INPUT tag. If you have a larger project consisting of a source directory or tree this may become tiresome. In this case you should put the root directory or directories after the \c INPUT tag, and add one or more file -patterns to the \c FILE_PATTERN tag. Only files that match one of the +patterns to the \c FILE_PATTERN tag (for instance <code>*.cpp *.h</code>). +Only files that match one of the patterns will be parsed (if the patterns are omitted all files will be parsed). For recursive parsing of a source tree you must set -the \c RECURSIVE tag to \c YES. To further finetune the list of files +the \c RECURSIVE tag to \c YES. To further fine-tune the list of files that is parsed the \c EXCLUDE and \c EXCLUDE_PATTERNS tags can be used. -If you start using Doxygen for an existing project (thus without any -documentation that Doxygen is aware of), you can still get an idea of +If you start using doxygen for an existing project (thus without any +documentation that doxygen is aware of), you can still get an idea of what the documented result would be. To do so, you must set the \c EXTRACT_ALL -tag in the configuration file to \c YES. Then, Doxygen will pretend +tag in the configuration file to \c YES. Then, doxygen will pretend everything in your sources is documented. Please note that warnings of undocumented members will not be generated as long as \c EXTRACT_ALL is set to \c YES. +To analyse an existing piece of software it is useful to cross-reference +a (documented) entity with its definition in the source files. Doxygen will +generate such cross-references if you set the SOURCE_BROWSER tag to YES. + \subsection step2 Step 2: Running doxygen To generate the documentation you can now enter: @@ -100,24 +108,28 @@ exist, \c doxygen will try to create it for you. The generated HTML documentation can be viewed by pointing a HTML browser to the \c index.html file in the \c html directory. For the best results a browser that supports cascading style sheets (CSS) should be used -(I'm currently using Netscape 4.0 to test the generated output). +(I'm currently using Netscape 4.61 to test the generated output). \addindex LaTeX The generated \f$\mbox{\LaTeX}\f$ documentation must first be compiled by -a \f$\mbox{\LaTeX}\f$ compiler. (I use teTeX distribution version 0.4 +a \f$\mbox{\LaTeX}\f$ compiler. (I use teTeX distribution version 0.9 that contains \f$\mbox{\TeX}\f$ version 3.14159). To simplify the process of compiling the generated documentation, \c doxygen writes a \c Makefile into the \c latex directory. By typing \c make in the \c latex directory the dvi file \c refman.dvi -will be generated. This file can then be viewed using \c xdvi or +will be generated (provided that you have a make tool called +<code>make</code> ofcourse). This file can then be viewed using \c xdvi or converted into a postscript file \c refman.ps by typing <code>make ps</code> -(this requires \c dvips ). The Postscript file can be send to a postscript +(this requires \c dvips ). Conversion to PDF is also possible; just type +<code>make pdf</code>. The Postscript file can be send to a postscript printer. If you do not have a postscript printer, you can try to use ghostscript to convert postscript into something your printer understands. +To get the best results for PDF output you should set the +\c PDF_HYPERLINKS tag to \c YES. The generated man pages can be viewed using the \c man program. You do need -to make sure the man directory is in the man path (see the MANPATH -environment variable). Notice that there are some limitations to the +to make sure the man directory is in the man path (see the \c MANPATH +environment variable). Note that there are some limitations to the capabilities of the man page format, so some information (like class diagrams, cross references and formulas) will be lost. @@ -125,7 +137,7 @@ capabilities of the man page format, so some information Although documenting the source is presented as step 3, in a new project this should ofcourse be step 1. Here I assume -you already have some code and you want Doxygen to generate a nice document +you already have some code and you want doxygen to generate a nice document describing the API and maybe the internals as well. If the \c EXTRACT_ALL option is set to \c NO in the configuration file @@ -141,7 +153,7 @@ these? For members, classes and namespaces there are basicly two options: <li>Place a special documentation block somewhere else (another file or another location) \e and put a <em>structural command</em> in the documentation block. A structural command links a documentation block - to a certain object that can be documented (e.g. a member, class, + to a certain entity that can be documented (e.g. a member, class, namespace or file). See section \ref structuralcommands to learn more about structural commands. </ol> @@ -170,7 +182,7 @@ During parsing the following steps take place: \subsection specialblock Special documentation blocks -The following types of special documentation blocks are supported by Doxygen: +The following types of special documentation blocks are supported by doxygen: <ul> <li>The Qt style, where special documentation blocks look like: \verbatim @@ -196,14 +208,14 @@ Here is an example of a documented piece of C++ code using the Qt style: \verbinclude qtstyle.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/qtstyle/html/class_test.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly The one-line comments should contain a brief description, whereas the multi-line comment blocks contain a more detailed description. The brief descriptions are included in the member overview of a class, namespace or file and are printed using a small italic font -(this description can be omitted by setting \c BRIEF_STDMETHOD_DESC to \c NO in +(this description can be omitted by setting \c BRIEF_MEMBER_DESC to \c NO in the config file). By default the brief descriptions are also the first sentence of the detailed description (this can be changed by setting the \c REPEAT_BRIEF tag to \c NO). @@ -215,15 +227,15 @@ style: \verbinclude jdstyle.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/jdstyle/html/class_test.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly -Notice that the first sentence of the documentation (until the <tt>.</tt>) +Note that the first sentence of the documentation (until the <tt>.</tt>) is treated as a brief description, whereas the documentation block as a whole forms the detailed description. The brief description is required for the JavaDoc style. -Unlike most other documentation systems, Doxygen also allows you to put +Unlike most other documentation systems, doxygen also allows you to put the documentation of members (including global functions) in front of the \e definition. This way the documentation can be placed in the source file instead of the header file. This keeps the header file compact, and allows the @@ -248,7 +260,7 @@ Structural commands (like all other commands) start with a backslash (<tt>\\</tt>) followed by a command name and one or more parameters. For instance, if you want to document the class \c Test in the example above, you could have also put the following documentation block somewhere -in the input that is read by Doxygen: +in the input that is read by doxygen: \verbatim /*! \class Test \brief A test class. @@ -271,7 +283,7 @@ Other structural commands are: <li>\c \namespace to document a namespace. </ul> See section \ref commands for detailed information about these and other -commands. Notice that the documentation block belonging to a file +commands. Note that the documentation block belonging to a file should always contain a structural command. To document a member of a C++ class, you must also document the class @@ -285,10 +297,10 @@ using structural commands: \verbinclude structcmd.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd.h.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly -\par Notice: +\par Note: Because each comment block in the example above contains a structural command, all the comment blocks could be moved to another location or input file (the source file for instance), without affecting the generated @@ -300,7 +312,7 @@ using structural commands: If you want to document the members of a file, struct, union, class, or enum and you want to put the documentation for these members inside the compound, it is sometimes desired to place the documentation block after the member -instead of before. For this purpose Doxygen has the following +instead of before. For this purpose doxygen has the following additional comment blocks: \verbatim /*!< ... */ @@ -318,7 +330,7 @@ and \verbatim ///< ... \endverbatim -Notice that these blocks have the same structure and meaning as the +Note that these blocks have the same structure and meaning as the special comment blocks above only the \< indicates that the member is located in front of the block instead of after the block. @@ -326,7 +338,7 @@ Here is an example of a the use of these comment blocks: \verbinclude afterdoc.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/afterdoc/html/class_test.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \warning These blocks can only be used to document \e members. @@ -343,11 +355,11 @@ in the HTML documentation, you will also need to have the following tools installed <ul> <li>\c latex: the \f$\mbox{\LaTeX}\f$ compiler, needed to parse the formulas. - To test I have used the teTeX 0.4 distribution. + To test I have used the teTeX 0.9 distribution. <li>\c dvips: a tool to convert dvi files to postscript files - I have used version 5.58f from Radical Eye software for testing. + I have used version 5.86 from Radical Eye software for testing. <li>\c gs: the ghostscript interpreter for converting postscript files - to bitmaps. I have used Aladdin Ghostscript 5.01 for testing. + to bitmaps. I have used Aladdin Ghostscript 5.10 for testing. </ul> There are two ways to include formulas in the documentation. @@ -392,7 +404,7 @@ There are two ways to include formulas in the documentation. </ol> Formulas should be valid commands in \f$\mbox{\LaTeX}\f$'s math-mode. -\warning Currently, Doxygen is not very fault tolerant in recovering +\warning Currently, doxygen is not very fault tolerant in recovering from typos in formulas. It may have to be necessary to remove the file <code>formula.repository</code> that is written in the html directory to a rid of an incorrect formula @@ -442,7 +454,7 @@ after preprocessing becomes: static const char * version = "1.xx"; \endverbatim -Notice that doxygen will now expand \e all macro definitions +Note that doxygen will now expand \e all macro definitions (recursively if needed). This is often too much. Therefore, doxygen also allows you to expand only those defines that you explicitly specify. For this you have to set the \c EXPAND_ONLY_PREDEF tag to \c YES @@ -500,11 +512,11 @@ class IUnknown }; \endverbatim -Notice that the \c PREDEFINED tag accepts function like macro definitions +Note that the \c PREDEFINED tag accepts function like macro definitions (like \c DECLARE_INTERFACE), normal macro substitutions (like \c PURE and \c THIS) and plain defines (like \c __cplusplus). -Notice also that preprocessor definitions that are normally defined +Note also that preprocessor definitions that are normally defined automatically by the preprocessor (like \c __cplusplus), have to be defined by hand with doxygen's parser (this is done because these defines are often platform/compiler specific). |