diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index b0b9bc2..087fad0 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -145,7 +145,7 @@ documentation: \endlatexonly The following subsections provide a list of all commands that are recognized by -Doxygen. Unrecognized commands are treated as normal text. +doxygen. Unrecognized commands are treated as normal text. <h2>\htmlonly <center> --- \endhtmlonly Structural indicators @@ -204,7 +204,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude class.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/class/html/index.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly <hr> @@ -218,7 +218,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude define.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_8h.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly <hr> @@ -231,7 +231,7 @@ Doxygen. Unrecognized commands are treated as normal text. categories. You can also use groups as members of other groups, thus building a hierarchy of groups. - The \<name\> argument should be a single word identifier. + The \<name\> argument should be a single-word identifier. \sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup", \ref cmdweakgroup "\\weakgroup". @@ -256,7 +256,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude enum.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/enum/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 <hr> @@ -271,7 +271,7 @@ Doxygen. Unrecognized commands are treated as normal text. If any are found, the names are cross-referenced with the documentation. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. If \<file-name\> itself is not unique for the set of example files specified by the @@ -287,7 +287,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude example_test.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/example/html/examples.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \sa section \ref cmdinclude "\\include". @@ -310,7 +310,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude file.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_8h.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly <hr> @@ -331,7 +331,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude func.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/func/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 \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". @@ -343,7 +343,7 @@ Doxygen. Unrecognized commands are treated as normal text. By default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines. By putting this command in a comment block of a define or variable, the - initializer always hidden. + initializer is always hidden. \sa section \ref cmdshowinitializer "\\showinitializer". @@ -461,7 +461,7 @@ Public/Protected/Private/... section. \verbinclude examples/overload.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/overload/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 <hr> @@ -471,14 +471,14 @@ Public/Protected/Private/... section. Indicates that a comment block contains a piece of documentation that is not directly related to one specific class, file or member. The HTML generator creates a page containing the documentation. The - \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly generator + \f$\mbox{\LaTeX}\f$ generator starts a new section in the chapter `Page documentation'. \par Example: \verbinclude page.doc \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/page/html/pages.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 Note: @@ -509,7 +509,7 @@ Public/Protected/Private/... section. \verbinclude relates.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/relates/html/class_string.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly <hr> @@ -537,7 +537,7 @@ Public/Protected/Private/... section. \subsection cmdtypedef \typedef (typedef declaration) \addindex \typedef - Indicates that a comment block contains documentation for a typedef, + Indicates that a comment block contains documentation for a typedef (either global or as a member of a class). This command is equivalent to \\var and \\fn. @@ -557,7 +557,7 @@ Public/Protected/Private/... section. \subsection cmdvar \var (variable declaration) \addindex \var - Indicates that a comment block contains documentation for a variable, + Indicates that a comment block contains documentation for a variable or enum value (either global or as a member of a class). This command is equivalent to \\typedef and \\fn. @@ -606,7 +606,7 @@ Public/Protected/Private/... section. \verbinclude author.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_windows_n_t.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly <hr> @@ -771,7 +771,7 @@ Public/Protected/Private/... section. \verbinclude par.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/par/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 <hr> @@ -821,7 +821,7 @@ Public/Protected/Private/... section. \subsection cmdremarks \remarks { remark text } \addindex \remarks - Starts a paragraph where one or more marks may be entered. + Starts a paragraph where one or more remarks may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. @@ -847,7 +847,7 @@ Public/Protected/Private/... section. \subsection cmdretval \retval <return value> { description } \addindex \retval - Starts a return value for a function with name + Starts a return value description for a function with name \<return value\>. Followed by a description of the return value. The text of the paragraph that forms the description has no special internal structure. All visual enhancement commands may be used inside the @@ -863,7 +863,7 @@ Public/Protected/Private/... section. \addindex \sa Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. - Two names joines by either <code>::</code> or <code>\#</code> + Two names joined by either <code>::</code> or <code>\#</code> are understood as referring to a class and one of its members. One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after @@ -975,7 +975,7 @@ Public/Protected/Private/... section. \subsection cmdlink \link <link-object> \addindex \link - The links that are automatically generated by Doxygen always have the + The links that are automatically generated by doxygen always have the name of the object they point to as link-text. The \\link command can be used to create a link to an object (a file, @@ -1048,7 +1048,7 @@ Public/Protected/Private/... section. add documentation between the pieces. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. The class and member declarations and definitions inside the code fragment are `remembered' during the parsing of the comment block that contained @@ -1065,7 +1065,7 @@ Public/Protected/Private/... section. \verbinclude example_test.cpp \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/include/html/example.html">here</a> - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \sa sections \ref cmdline "\\line", \ref cmdskip "\\skip", @@ -1079,7 +1079,7 @@ Public/Protected/Private/... section. The command takes the name of an include file as an argument. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. If \<file-name\> itself is not unique for the set of example files specified by the @@ -1178,7 +1178,7 @@ Public/Protected/Private/... section. placing \\verbatim and \\endverbatim commands around it. Files or directories that doxygen should look for can be specified using the - \ref cfg_example_path "EXAMPLE_PATH" tag of Doxygen's configuration file. + \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file. <hr> \subsection cmdhtmlinclude \htmlinclude <file-name> @@ -1189,7 +1189,7 @@ Public/Protected/Private/... section. placing \\htmlonly and \\endhtmlonly commands around it. Files or directories that doxygen should look for can be specified using the - \ref cfg_example_path "EXAMPLE_PATH" tag of Doxygen's configuration file. + \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file. <hr> <h2>\htmlonly <center> --- \endhtmlonly @@ -1378,7 +1378,7 @@ Public/Protected/Private/... section. endhtmlonly command. This command can be used to include HTML code that is too complex - for Doxygen (i.e. applets, java-scripts, and HTML tags that + for doxygen (i.e. applets, java-scripts, and HTML tags that require attributes). You can use the \\latexonly and \\endlatexonly pair to provide a proper \f$\mbox{\LaTeX}\f$ alternative. @@ -1401,12 +1401,12 @@ Public/Protected/Private/... section. following values are supported: \c html and \c latex. The second argument specifies the file name of the image. - Doxygen will look for files in the paths (or files) that you specified + doxygen will look for files in the paths (or files) that you specified after the \ref cfg_image_path "IMAGE_PATH" tag. If the image is found it will be copied to the correct output directory. If the image name contains spaces you'll have to put quotes (") around it. You can also specify an absolute URL instead of a file name, but then - doxygen does not copy the image or check its existance. + doxygen does not copy the image nor check its existance. The third argument is optional and can be used to specify the caption that is displayed below the image. This argument has to be specified @@ -1439,9 +1439,9 @@ Public/Protected/Private/... section. \warning The image format for HTML is limited to what your browser supports. For \f$\mbox{\LaTeX}\f$ the image format - must be an encapsulated postscipt (eps). + must be Encapsulated PostScipt (eps). <br><br> - Doxygen does not check if the image is in the correct format. + doxygen does not check if the image is in the correct format. So \e you have to make sure this is the case! <hr> @@ -1453,7 +1453,7 @@ Public/Protected/Private/... section. endlatexonly command. This command can be used to include \f$\mbox{\LaTeX}\f$ code that is too - complex for Doxygen (i.e. images, formulas, special characters). You can + complex for doxygen (i.e. images, formulas, special characters). You can use the \\htmlonly and \\endhtmlonly pair to provide a proper HTML alternative. @@ -1531,7 +1531,7 @@ Public/Protected/Private/... section. \addindex \\ This command writes a backslash character (\\) to the HTML and \f$\mbox{\LaTeX}\f$ output. The backslash has to be escaped in some - cases because Doxygen uses it to detect commands. + cases because doxygen uses it to detect commands. <hr> \subsection cmdat \@ @@ -1539,7 +1539,7 @@ Public/Protected/Private/... section. \addindex \@ This command writes an at-sign (@) to the HTML and \f$\mbox{\LaTeX}\f$ output. The at-sign has to be escaped in some cases - because Doxygen uses it to detect JavaDoc commands. + because doxygen uses it to detect JavaDoc commands. <hr> \subsection cmdamp \& |