diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.in | 8 | ||||
| -rw-r--r-- | doc/Makefile.win_make.in | 10 | ||||
| -rw-r--r-- | doc/Makefile.win_nmake.in | 2 | ||||
| -rw-r--r-- | doc/commands.doc | 70 | ||||
| -rw-r--r-- | doc/config.doc | 83 | ||||
| -rw-r--r-- | doc/diagrams.doc | 6 | ||||
| -rw-r--r-- | doc/docblocks.doc | 2 | ||||
| -rw-r--r-- | doc/doxygen_usage.doc | 4 | ||||
| -rw-r--r-- | doc/doxysearch_usage.doc | 8 | ||||
| -rw-r--r-- | doc/external.doc | 4 | ||||
| -rw-r--r-- | doc/faq.doc | 8 | ||||
| -rw-r--r-- | doc/features.doc | 12 | ||||
| -rw-r--r-- | doc/formulas.doc | 16 | ||||
| -rw-r--r-- | doc/history.doc | 4 | ||||
| -rw-r--r-- | doc/htmlcmds.doc | 37 | ||||
| -rw-r--r-- | doc/index.doc | 20 | ||||
| -rw-r--r-- | doc/install.doc | 31 | ||||
| -rw-r--r-- | doc/maintainers.txt | 4 | ||||
| -rw-r--r-- | doc/output.doc | 4 | ||||
| -rw-r--r-- | doc/starting.doc | 10 |
20 files changed, 179 insertions, 164 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in index 90c7d94..38675ed 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -12,7 +12,7 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -all: FORCE +all: language FORCE DOXYGEN_DOCDIR=$(DOXYDOCS); \ export DOXYGEN_DOCDIR; \ VERSION=$(VERSION) ; \ @@ -28,9 +28,11 @@ all: FORCE clean: rm -rf ../html ../latex language.doc -language: language.doc language.tpl translator.pl +language: language.doc -language.doc: language.tpl FORCE +translators: $(wildcard ../src/translator_*.h) + +language.doc: translators maintainers.txt language.tpl translator.pl $(PERL) translator.pl FORCE: diff --git a/doc/Makefile.win_make.in b/doc/Makefile.win_make.in index b1a2009..3b7c3c7 100644 --- a/doc/Makefile.win_make.in +++ b/doc/Makefile.win_make.in @@ -12,7 +12,7 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -all: +all: language FORCE @xcopy /s /q /i ..\examples ..\html\examples set DOXYGEN_DOCDIR=. & \ set VERSION=$(VERSION) & \ @@ -26,5 +26,13 @@ all: clean: del /s /q ..\html ..\latex + del translator_report.txt *.bak + +language: language.doc + +translators: ..\src\translator_*.h + +language.doc: translators maintainers.txt language.tpl translator.pl + $(PERL) translator.pl FORCE: diff --git a/doc/Makefile.win_nmake.in b/doc/Makefile.win_nmake.in index 92829a1..dd53b22 100644 --- a/doc/Makefile.win_nmake.in +++ b/doc/Makefile.win_nmake.in @@ -12,7 +12,7 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -all: FORCE +all: language FORCE @xcopy /s /q /i ..\examples ..\html\examples set DOXYGEN_DOCDIR=. set VERSION=$(VERSION) 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 \& diff --git a/doc/config.doc b/doc/config.doc index f5d1f1e..13d3991 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -14,7 +14,7 @@ * input used in their production; they are not affected by this license. * */ -/*! \page config +/*! \page config Configuration \section config Configuration @@ -213,7 +213,7 @@ followed by the descriptions of the tags grouped by category. <dt>\c OUTPUT_DIRECTORY <dd> \addindex OUTPUT_DIRECTORY The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) - path into which the generated HTML and Latex documentation will be written. + path into which the generated documentation will be written. If a relative path is entered, it will be relative to the location where doxygen was started. If left blank the current directory will be used. @@ -254,7 +254,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_undoc_members <dt>\c HIDE_UNDOC_MEMBERS <dd> \addindex HIDE_UNDOC_MEMBERS - If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, Doxygen will hide all + If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all undocumented members inside documented classes or files. If set to \c NO (the default) these members will be included in the various overviews, but no documentation section is generated. @@ -263,7 +263,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_undoc_classes <dt>\c HIDE_UNDOC_CLASSES <dd> \addindex HIDE_UNDOC_CLASSES - If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, Doxygen will hide all + If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, doxygen will hide all undocumented classes. If set to \c NO (the default) these classes will be included in the various overviews. @@ -272,7 +272,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_brief_member_desc <dt>\c BRIEF_MEMBER_DESC <dd> \addindex BRIEF_MEMBER_DESC - If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) Doxygen will + If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to JavaDoc). Set to NO to disable this. @@ -280,7 +280,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_repeat_brief <dt>\c REPEAT_BRIEF <dd> \addindex REPEAT_BRIEF - If the \c REPEAT_BRIEF tag is set to \c YES (the default) Doxygen will + If the \c REPEAT_BRIEF tag is set to \c YES (the default) doxygen will prepend the brief description of a member or function before the detailed description @@ -292,13 +292,13 @@ followed by the descriptions of the tags grouped by category. <dt>\c ALWAYS_DETAILED_SEC <dd> \addindex ALWAYS_DETAILED_SEC If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then - Doxygen will generate a detailed section even if there is only a brief + doxygen will generate a detailed section even if there is only a brief description. \anchor cfg_full_path_names <dt>\c FULL_PATH_NAMES <dd> \addindex FULL_PATH_NAMES - If the \c FULL_PATH_NAMES tag is set to \c YES Doxygen will prepend the full + If the \c FULL_PATH_NAMES tag is set to \c YES doxygen will prepend the full path before files name in the file list and in the header files. If set to NO the shortest path that makes the file name unique will be used @@ -321,8 +321,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_class_diagrams <dt>\c CLASS_DIAGRAMS <dd> \addindex CLASS_DIAGRAMS - If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) Doxygen will - generate a class diagram (in Html and \f$\mbox{\LaTeX}\f$) for classes with base or + If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) doxygen will + generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or super classes. Setting the tag to \c NO turns the diagrams off. \anchor cfg_source_browser @@ -347,7 +347,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_case_sense_names <dt>\c CASE_SENSE_NAMES <dd> \addindex CASE_SENSE_NAMES - If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then Doxygen + If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then doxygen will only generate file names in lower case letters. If set to \c YES upper case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system @@ -363,14 +363,14 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_scope_names <dt>\c HIDE_SCOPE_NAMES <dd> \addindex HIDE_SCOPE_NAMES - If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then Doxygen + If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen will show members with their full class and namespace scopes in the documentation. If set to \c YES the scope will be hidden. \anchor cfg_verbatim_headers <dt>\c VERBATIM_HEADERS <dd> \addindex VERBATIM_HEADERS - If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then Doxygen + If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this. \sa Section \ref cmdclass "\\class". @@ -378,14 +378,14 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_show_include_files <dt>\c SHOW_INCLUDE_FILES <dd> \addindex SHOW_INCLUDE_FILES - If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen + If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen will put list of the files that are included by a file in the documentation of that file. \anchor cfg_javadoc_autobrief <dt>\c JAVADOC_AUTOBRIEF <dd> \addindex JAVADOC_AUTOBRIEF - If the \c JAVADOC_AUTOBRIEF is set to \c YES then Doxygen + If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like the Qt-style comments. @@ -665,7 +665,7 @@ followed by the descriptions of the tags grouped by category. <dt>\c GENERATE_HTML <dd> \addindex GENERATE_HTML - If the \c GENERATE_HTML tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_HTML tag is set to \c YES (the default) doxygen will generate HTML output \anchor cfg_html_output @@ -760,16 +760,16 @@ followed by the descriptions of the tags grouped by category. \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a project file that can be read by <a href="http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download_main.htm"> - Microsoft HTML help workshop</a> + Microsoft HTML Help Workshop</a> \latexonly (see http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download\_main.htm) \endlatexonly on Windows. - The HTML workshop contains a compiler that can convert all HTML output + The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compressed HTML file (.chm). Compressed HTML files are now used as the Windows 98 help format, and will replace - the old windows help format (.hlp) on all Windows platforms in the future. + the old Windows help format (.hlp) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, and you can search for words in the documentation (which basically renders \c doxysearch obsolete on Windows). @@ -792,8 +792,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_toc_expand <dt>\c TOC_EXPAND <dd> \addindex TOC_EXPAND - The \c TOC_EXPAND flag can be set YES to add extra items for - group members to the table of contents of the Html help documentation + The \c TOC_EXPAND flag can be set to YES to add extra items for + group members to the table of contents of the HTML help documentation and to the tree view. \anchor cfg_disable_index @@ -834,8 +834,8 @@ followed by the descriptions of the tags grouped by category. <dt>\c GENERATE_LATEX <dd> \addindex GENERATE_LATEX - If the \c GENERATE_LATEX tag is set to \c YES (the default) Doxygen will - generate Latex output. + If the \c GENERATE_LATEX tag is set to \c YES (the default) doxygen will + generate \f$\mbox{\LaTeX}\f$ output. \anchor cfg_latex_output <dt>\c LATEX_OUTPUT <dd> @@ -848,7 +848,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_compact_latex <dt>\c COMPACT_LATEX <dd> \addindex COMPACT_LATEX - If the \c COMPACT_LATEX tag is set to \c YES Doxygen generates more compact + If the \c COMPACT_LATEX tag is set to \c YES doxygen generates more compact \f$\mbox{\LaTeX}\f$ documents. This may be useful for small projects and may help to save some trees in general. @@ -881,8 +881,8 @@ EXTRA_PACKAGES = times <dt>\c LATEX_HEADER <dd> \addindex LATEX_HEADER The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ - header for the generated latex document. The header should contain everything - until the first chapter. + header for the generated \f$\mbox{\LaTeX}\f$ document. + The header should contain everything until the first chapter. If it is left blank doxygen will generate a standard header. See section \ref doxygen_usage for information on how to @@ -904,10 +904,11 @@ EXTRA_PACKAGES = times <dt>\c PDF_HYPERLINKS <dd> \addindex PDF_HYPERLINKS - If the \c PDF_HYPERLINKS tag is set to \c YES, the LaTeX that is generated - is prepared for conversion to pdf (using ps2pdf). The pdf file will + If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that + is generated is prepared for conversion to PDF (using ps2pdf). + The PDF file will contain links (just like the HTML output) instead of page references - This makes the output suitable for online browsing using a pdf viewer. + This makes the output suitable for online browsing using a PDF viewer. \anchor cfg_latex_batchmode <dt>\c LATEX_BATCHMODE <dd> @@ -926,7 +927,7 @@ EXTRA_PACKAGES = times <dt>\c GENERATE_RTF <dd> \addindex GENERATE_RTF - If the \c GENERATE_RTF tag is set to \c YES Doxygen will generate RTF output. + If the \c GENERATE_RTF tag is set to \c YES doxygen will generate RTF output. The RTF output is optimised for Word 97 and may not look too pretty with other readers/editors. @@ -940,7 +941,7 @@ EXTRA_PACKAGES = times \anchor cfg_compact_rtf <dt>\c COMPACT_RTF <dd> \addindex COMPACT_RTF - If the \c COMPACT_RTF tag is set to \c YES Doxygen generates more compact + If the \c COMPACT_RTF tag is set to \c YES doxygen generates more compact RTF documents. This may be useful for small projects and may help to save some trees in general. @@ -954,7 +955,7 @@ EXTRA_PACKAGES = times Word compatible reader that support those fields. \par note: - wordpad (write) and others do not support links. + WordPad (write) and others do not support links. \anchor cfg_rtf_stylesheet_file <dt>\c RTF_STYLESHEET_FILE <dd> @@ -968,7 +969,7 @@ EXTRA_PACKAGES = times \anchor cfg_rtf_extensions_file <dt>\c RTF_EXTENSIONS_FILE <dd> - Set optional variables used in the generation of an rtf document. + Set optional variables used in the generation of an RTF document. Syntax is similar to doxygen's config file. A template extensions file can be generated using <code>doxygen -e rtf extensionFile</code>. @@ -981,7 +982,7 @@ EXTRA_PACKAGES = times <dt>\c GENERATE_MAN <dd> \addindex GENERATE_MAN - If the \c GENERATE_MAN tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_MAN tag is set to \c YES (the default) doxygen will generate man pages for classes and files. \anchor cfg_man_output @@ -1002,7 +1003,7 @@ EXTRA_PACKAGES = times \anchor cfg_man_links <dt>\c MAN_LINKS <dd> \addindex MAN_LINKS - If the \c MAN_LINKS tag is set to \c YES and Doxygen generates man output, + If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output, then it will generate one additional man file for each entity documented in the real man page(s). These additional files only source the real man page, but without them the man command would be unable to find the correct page. @@ -1016,14 +1017,14 @@ EXTRA_PACKAGES = times <dt>\c ENABLE_PREPROCESSING <dd> \addindex ENABLE_PREPROCESSING - If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) Doxygen will + If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) doxygen will evaluate all C-preprocessor directives found in the sources and include files. \anchor cfg_macro_expansion <dt>\c MACRO_EXPANSION <dd> \addindex MACRO_EXPANSION - If the \c MACRO_EXPANSION tag is set to \c YES Doxygen will expand all macro + If the \c MACRO_EXPANSION tag is set to \c YES doxygen will expand all macro names in the source code. If set to \c NO (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting \c EXPAND_ONLY_PREDEF to \c YES. @@ -1039,7 +1040,7 @@ EXTRA_PACKAGES = times <dt>\c SEARCH_INCLUDES <dd> \addindex SEARCH_INCLUDES If the \c SEARCH_INCLUDES tag is set to \c YES (the default) the includes files - in the \c INCLUDE_PATH (see below) will be search if a \#include is found. + in the \c INCLUDE_PATH (see below) will be searched if a \#include is found. \anchor cfg_include_path <dt>\c INCLUDE_PATH <dd> @@ -1195,7 +1196,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> \anchor cfg_generate_legend <dd> <dt>\c GENERATE_LEGEND <dd> \addindex GENERATE_LEGEND - If the \c GENERATE_LEGEND tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_LEGEND tag is set to \c YES (the default) doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs. @@ -1222,7 +1223,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> <dt>\c CGI_URL <dd> \addindex CGI_URL The \c CGI_URL tag should be the absolute URL to the directory where the - cgi binaries are located. See the documentation of your http daemon for + cgi binaries are located. See the documentation of your HTTP daemon for details. \anchor cfg_doc_url @@ -1363,7 +1364,7 @@ EXPAND_AS_DEFINED = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \ Q_VARIANT_AS \endverbatim -Here Doxygen's preprocessor is used to substitute some +Here doxygen's preprocessor is used to substitute some macro names that are normally substituted by the C preprocessor, but without doing full macro expansion. diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 2153f16..3217800 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -61,7 +61,7 @@ little marker in the lower right corner to indicate that the class contains base classes that are hidden. For the class diagrams the maximum tree width is currently 8 elements. - If a tree wider some nodes will be hidden. + If a tree is wider some nodes will be hidden. If the box is filled with a dashed pattern the inheritance relation is virtual. <li> A \b white box indicates that the documentation of the class @@ -81,7 +81,7 @@ If the box has a \b dashed border this indicates virtual inheritance. <li> A \b solid arrow indicates public inheritance. <li> A \b dashed arrow indicates protected inheritance. - <li> A \b dotted arrow indicated private inheritance. + <li> A \b dotted arrow indicates private inheritance. </ul> The elements in the graphs generated by the dot tool have the following @@ -91,7 +91,7 @@ <li> A box with a \b red border indicates a node that has \e more arrows than are shown! In order words: the graph is \e truncated with respect to this node. - The reason a graph is sometimes truncated is too prevent images + The reason a graph is sometimes truncated is to prevent images from becoming too large. For the graphs generated with dot doxygen tries to limit the width of the resulting image to 1024 pixels. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 547e617..bb73ccb 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -204,7 +204,7 @@ Here is an example of the use of these comment blocks: for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly -\warning These blocks can only be used to document \e members. +\warning These blocks can only be used to document \e members and \e parameters. They cannot be used to document files, classes, unions, structs, groups, namespaces and enums themselves. Furthermore, the structural commands mentioned in the previous section diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index 5796896..865f5ca 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -44,7 +44,7 @@ doxygen <config_file> </ol> If you have a configuration file generated with an older version of -doxygen that you can upgrade it to the current version by running doxygen +doxygen, you can upgrade it to the current version by running doxygen with the -u option. \verbatim doxygen -u <config_file> @@ -85,7 +85,7 @@ doxygen -w rtf rtfstyle.cfg file then you can use the optional \c -s option. This can use be used in combination with the \c -u option, to add or strip the documentation from an existing configuration file. - Please use the \c -s this option if you send me a configuration file + Please use the \c -s option if you send me a configuration file as part of a bug report! <li> To make doxygen read/write to standard input/output instead of from/to a file, use \c - for the file name. diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc index 72dc397..6d6ad29 100644 --- a/doc/doxysearch_usage.doc +++ b/doc/doxysearch_usage.doc @@ -27,7 +27,7 @@ Doxysearch must be run as a CGI binary. This implies the following: <li> You must have permission to install and execute a CGI binary on the target. </ul> -Ask you system administrator or provider if you are unsure if this is possible. +Ask your system administrator or provider if you are unsure if this is possible. In order to be able to search fast and efficient, doxysearch does not search the generated documentation directly. Instead, it uses an @@ -131,8 +131,8 @@ This can be done by carefully following these steps: \par Note: Doxytag requires quite a large amount of memory to - generate the search index (about 30 Mb on my Linux box)! - The resulting index file requires about 3 Mb space on your disk. + generate the search index (about 30 MB on my Linux box)! + The resulting index file requires about 3 MB space on your disk. <li>Edit the shell script <code>search.cgi</code> with a text editor. @@ -174,7 +174,7 @@ http://blizzard/cgi-bin/search.cgi \endverbatim in the additional information section of the <code>index.html</code> file. <li>Start your favourite web browser and click on the link. - If everything is ok, you should get a page where you can enter + If everything is OK, you should get a page where you can enter search terms. </ol> diff --git a/doc/external.doc b/doc/external.doc index d8f4285..f3a1e05 100644 --- a/doc/external.doc +++ b/doc/external.doc @@ -45,7 +45,7 @@ To generate a tag file for your project, simply put the name of the tag file after the \ref cfg_generate_tagfile "GENERATE_TAGFILE" option in the configuration file. -To combine the output of one or more external projects with you own project +To combine the output of one or more external projects with your own project you should specify the name of the tag files after the \ref cfg_tagfiles "TAGFILES" option in the configuration file. @@ -57,7 +57,7 @@ There are two ways to do this: <dt>At configuration time:<dd> just assign the location of the output to the tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration option. If you use a relative path it should be relative with respect to - the directory where the html output of your project is generated. + the directory where the HTML output of your project is generated. <dt>After compile time:<dd> if you do not assign a location to a tag file, doxygen will generate dummy links for all external HTML references. It will also generate a perl script called \ref installdox_usage "installdox" in diff --git a/doc/faq.doc b/doc/faq.doc index 7b4894b..f20dfc0 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -91,7 +91,7 @@ around the blocks that should be hidden and put: in the config file then all blocks should be skipped by Doxygen as long as <code>PREPROCESSING = YES</code>. -<li><b>How can I change what's after the <code>\#include</code> in the class documentation?</b> +<li><b>How can I change what is after the <code>\#include</code> in the class documentation?</b> You can document your class like @@ -119,7 +119,7 @@ brackets you should type: */ \endverbatim -<li><b>How can I use tag files in combination with compressed HTML</b> +<li><b>How can I use tag files in combination with compressed HTML?</b> If you want to refer from one compressed HTML file \c a.chm to another compressed HTML file @@ -160,7 +160,7 @@ doxygen generates. You can include this by putting \verbatim <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> \endverbatim -In the HEAD section of the HTML page. +in the HEAD section of the HTML page. <li><b>Why does doxygen use Qt?</b> @@ -194,7 +194,7 @@ This error happens when doxygen lexical scanner has a rules that matches more than 16K input character in one go. I've seen this happening on a very large generated file (>16K lines), where the built-in preprocessor converted it into an empty file (with >16K of newlines). Another case -where this might happen is if you have lines in you code with more than +where this might happen is if you have lines in your code with more than 16K characters. </ol> diff --git a/doc/features.doc b/doc/features.doc index 68d54f0..053a9db 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -14,7 +14,7 @@ * input used in their production; they are not affected by this license. * */ -/*! \page features.html +/*! \page features Features \section features Features @@ -23,12 +23,12 @@ <li>Requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used. -<li>Supports C++, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources. +<li>Supports C++, Java, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources. <li>Supports documentation of files, namespaces, classes, structs, unions, templates, variables, functions, typedefs, enums and defines. <li>JavaDoc (1.1), Qt-Doc, and KDOC compatible. <li>Automatically generates class diagrams in HTML (as clickable - image maps) and \f$\mbox{\LaTeX}\f$ (as encapsulated postscript images). + image maps) and \f$\mbox{\LaTeX}\f$ (as Encapsulated PostScript images). <li>Uses the dot tool of the Graphviz tool kit to generate include dependency graphs, collaboration diagrams, and graphical class hierarchy graphs. @@ -38,11 +38,11 @@ <li>Can generate a list of all members of a class (including any inherited members) along with their protection level. <li>Outputs documentation in on-line format (HTML and UNIX man page) and - off-line format (\f$\mbox{\LaTeX}\f$) and RTF simultaniously + off-line format (\f$\mbox{\LaTeX}\f$ and RTF) simultaneously (any of these can be disabled if desired). All formats are optimized for ease of reading. <br> Furthermore, compressed HTML can be generated from HTML output using - Microsoft's HTML help workshop (Windows only) and PDF can be generated + Microsoft's HTML Help Workshop (Windows only) and PDF can be generated from the \f$\mbox{\LaTeX}\f$ output. <li>Includes a full C preprocessor to allow proper parsing of conditional code fragments and to allow expansion of all or part of macros definitions. @@ -57,7 +57,7 @@ <li>Includes a fast, rank based search engine to search for strings or words in the class and member documentation. <li>You can type normal HTML tags in your documentation. Doxygen will convert - them to their equivalent \f$\mbox{\LaTeX}\f$ and man-page + them to their equivalent \f$\mbox{\LaTeX}\f$, RTF, and man-page counterparts automatically. <li>Allows references to documentation generated for other projects (or another part of the same project) in a location independent way. diff --git a/doc/formulas.doc b/doc/formulas.doc index bd1aa22..e90424f 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -17,17 +17,17 @@ /*! \page formulas Including formulas Doxygen allows you to put \f$\mbox{\LaTeX}\f$ formulas in the -output (this works only for the HTML and \f$\mbox{\LaTeX}\f$ formats, -not for the man page output). To be able to include formulas (as images) -in the HTML documentation, you will also need to have the following tools -installed +output (this works only for the HTML and \f$\mbox{\LaTeX}\f$ output, +not for the RTF nor for the man page output). To be able to include +formulas (as images) 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.9 distribution. -<li>\c dvips: a tool to convert dvi files to postscript files +<li>\c dvips: a tool to convert DVI files to PostScript files 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.10 for testing. +<li>\c gs: the GhostScript interpreter for converting PostScript files + to bitmaps. I have used Aladdin GhostScript 5.10 for testing. </ul> There are two ways to include formulas in the documentation. @@ -44,7 +44,7 @@ There are two ways to include formulas in the documentation. \f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$. <br> <li>Unnumbered displayed formulas that are centered on a separate line. - These formulas should be put between \\f\[ and \\f\] commands. + These formulas should be put between \\f[ and \\f] commands. An example: \verbatim \f[ diff --git a/doc/history.doc b/doc/history.doc index eb5f2f1..5a28e9d 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -24,7 +24,7 @@ <li>Using the dot tool of the AT&T's GraphViz package, doxygen can now generate inheritance diagrams, collaboration diagrams, include dependency graphs, included by graphs and graphical inheritance overviews. -<li>Function arguments can now be documentation with separate comment blocks. +<li>Function arguments can now be documented with separate comment blocks. <li>Initializers and macro definitions are now included in the documentation. <li>Variables and typedefs are now put in their own section. <li>Old configuration files can be upgraded using the -u option without @@ -52,7 +52,7 @@ <ul> <li>Support for templates and namespaces. <li>Internationalization support. Currently supported languages are: - English, Czech, German, Spanish, Finnish, French, Italian, Japanse, + English, Czech, German, Spanish, Finnish, French, Italian, Japanese, Dutch, and Swedish. <li>Automatic generation of inheritance diagrams for sub & super classes. <li>Support for man page, compressed HTML help, and hyperlinked PDF output. diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 0429139..79faf11 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -38,8 +38,8 @@ documentation. Note that all attributes of a HTML tag are ignored <li>\c </DFN> Ends a \c <DFN> section. <li>\c <DL> Starts a description list. <li>\c </DL> Ends a description list. -<li>\c <DT> Starts a item title. -<li>\c </DT> Does not generate any output. +<li>\c <DT> Starts an item title. +<li>\c </DT> Ends an item title. <li>\c <EM> Starts a piece of text displayed in an italic font. <li>\c </EM> Ends a \c <EM> section. <li>\c <FORM> Does not generate any output. @@ -52,35 +52,34 @@ documentation. Note that all attributes of a HTML tag are ignored <li>\c <H?> Where ? is one of {3,4,5,6}, starts an unnumbered subsubsection using \c <H3> in HTML. <li>\c </H?> Where ? is one of {3,4,5,6}, ends an unnumbered subsubsection using \c <H3> in HTML. <li>\c <I> Starts a piece of text displayed in an italic font. -<li>\c <INPUT> Does not generated any output. +<li>\c <INPUT> Does not generate any output. <li>\c </I> Ends a \c <I> section. <li>\c <IMG> This command is written with attributes to the HTML output only. <li>\c <LI> Starts a new list item. -<li>\c </LI> Does not generate any output. +<li>\c </LI> Ends a list item. <li>\c <META> Does not generate any output. -<li>\c <MULTICOL> ignored by Doxygen. -<li>\c </MUTLICOL> ignored by Doxygen. +<li>\c <MULTICOL> ignored by doxygen. +<li>\c </MUTLICOL> ignored by doxygen. <li>\c <OL> Starts a numbered item list. <li>\c </OL> Ends a numbered item list. <li>\c <P> Starts a new paragraph. -<li>\c </P> Does not generate any output. -<li>\c <PRE> starts a preformatted fragment. -<li>\c </PRE> ends a preformatted fragment. -<li>\c <SMALL> starts a section of text displayed in a smaller font. -<li>\c </SMALL> ends a \c <SMALL> section. -<li>\c <STRONG> starts a section of bold text. -<li>\c </STRONG> ends a section of bold text. +<li>\c </P> Ends a paragraph. +<li>\c <PRE> Starts a preformatted fragment. +<li>\c </PRE> Ends a preformatted fragment. +<li>\c <SMALL> Starts a section of text displayed in a smaller font. +<li>\c </SMALL> Ends a \c <SMALL> section. +<li>\c <STRONG> Starts a section of bold text. +<li>\c </STRONG> Ends a section of bold text. <li>\c <SUB> Starts a piece of text displayed in subscript. <li>\c </SUB> Ends a \c <SUB> section. <li>\c <SUP> Starts a piece of text displayed in superscript. <li>\c </SUP> Ends a \c </SUP> section. -<li>\c <TABLE> starts a table, the available space of a page is always - divided equally amount the columns. -<li>\c </TABLE> ends a table -<li>\c <TD> Starts a new table element. -<li>\c </TD> Does not generate any output. +<li>\c <TABLE> starts a table. +<li>\c </TABLE> ends a table. +<li>\c <TD> Starts a new table data element. +<li>\c </TD> Ends a table data element. <li>\c <TR> Starts a new table row. -<li>\c </TR> Does not generate any output. +<li>\c </TR> Ends a table row. <li>\c <TT> Starts a piece of text displayed in a typewriter font. <li>\c </TT> Ends a \c <TT> section. <li>\c <KBD> Starts a piece of text displayed in a typewriter font. diff --git a/doc/index.doc b/doc/index.doc index cb1b9c3..a66df37 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -14,7 +14,7 @@ * input used in their production; they are not affected by this license. * */ -/*! \page index +/*! \page index Index \if logo_on <center> \htmlonly @@ -41,7 +41,7 @@ See the GNU General Public License</a> for more details. <p> -Documents produced by Doxygen are derivative works derived from the +Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license. <h2>Introduction</h2> @@ -54,7 +54,7 @@ It can help you in three ways: off-line reference manual (in \f$\mbox{\LaTeX}\f$) from a set of documented source files. There is also support for generating output in RTF (MS-Word), - Postscript, hyperlinked PDF, compressed HTML, and Unix man pages. + PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. @@ -70,7 +70,7 @@ It can help you in three ways: Doxygen is developed under <a href="http://www.linux.org">Linux</a>, but is set-up to be highly portable. As a result, it runs on most -other UNIX flavors as well. Furthermore, an executable for +other Unix flavors as well. Furthermore, an executable for Windows 9x/NT is also available. This manual is divided into two parts, each of which is divided into several @@ -98,17 +98,17 @@ The first part forms a user manual: The second part forms a reference manual: <ul> -<li>Section \ref features presents an overview of what Doxygen can do. +<li>Section \ref features presents an overview of what doxygen can do. <li>Section \ref history shows what has changed during the development - of Doxygen and what still has to be done. + of doxygen and what still has to be done. <li>Section \ref doxygen_usage shows how to use the \c doxygen program. <li>Section \ref doxytag_usage shows how to use the \c doxytag program. <li>Section \ref doxysearch_usage shows how to use the \c doxysearch program. <li>Section \ref doxywizard_usage shows how to use the \c doxywizard program. <li>Section \ref installdox_usage shows how to use the \c installdox - script that is generated by Doxygen if you use tag files. + script that is generated by doxygen if you use tag files. <li>Section \ref output shows how to generate the various output formats - supported by Doxygen. + supported by doxygen. <li>Section \ref autolink shows how to put links to files, classes, and members in the documentation. <li>Section \ref config shows how to fine-tune doxygen, so it @@ -151,9 +151,9 @@ Thanks go to: <ul> \addindex Doc++ <li>Malte Zöckler and Roland Wunderling, authors of DOC++. - The first version of Doxygen borrowed some code of an old version of DOC++. + The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still - given me a good start in writing Doxygen. + given me a good start in writing doxygen. <li>All people at Troll Tech, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-) <li>My brother <a href="http://www.stack.nl/~fidget/index.html">Frank</a> diff --git a/doc/install.doc b/doc/install.doc index 2a5a6e6..79743b9 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -161,9 +161,10 @@ Compilation is now done by performing the following steps: make install \endverbatim - Binaries are installed in the directory <code>\<prefix\>/bin</code> - Documentation and examples in the directory - <code>\<prefix\>/doc/doxygen</code> + Binaries are installed in the directory <code>\<prefix\>/bin</code>, + documentation and examples in the directory + <code>\<prefix\>/share/doc/packages/doxygen</code> (use + <code>DOCDIR\\<path\></code> after <code>make</code> to change this). <code>\<prefix\></code> defaults to /usr but can be changed with the <code>--prefix</code> option of the configure script. @@ -182,12 +183,12 @@ Compilation is now done by performing the following steps: <b>Qt problems</b> -The Qt include files and libraries are not a sub directory of the -directory pointed to by QTDIR on some systems. +The Qt include files and libraries are not a subdirectory of the +directory pointed to by QTDIR on some systems (for instance on Red Hat 6.0 includes are in /usr/include/qt and -libs are in /usr/lib) +libs are in /usr/lib). -The solution: goto the root of the doxygen distribution and do: +The solution: go to the root of the doxygen distribution and do: \verbatim mkdir qt cd qt @@ -203,7 +204,7 @@ Now install doxygen as described above. <b>Latex problems</b> -the file <code>a4wide.sty</code> is not available for all distributions. If +The file <code>a4wide.sty</code> is not available for all distributions. If your distribution does not have it please select another paper type in the config file (see the \ref cfg_paper_type "PAPER_TYPE" tag in the config file). @@ -352,7 +353,7 @@ Here is what is required: Borland C++ or MINGW (see http://www.mingw.org) are also supported. -<li>Perl 5.0 or higher for Windows. This can be download from: +<li>Perl 5.0 or higher for Windows. This can be downloaded from: http://www.ActiveState.com/Products/ActivePerl/ <li>The GNU tools flex, bison, and sed. @@ -390,7 +391,7 @@ Here is what is required: As a result doxygen can be compiled on systems without X11 or the commerical version of Qt. - For doxywizard, a complete Qt library this is + For doxywizard, a complete Qt library is still a requirement however. You may be interested in the professional license of <A HREF="http://www.trolltech.com/products/qt.html">Qt for Windows</A> \latexonly\par (see @@ -400,7 +401,7 @@ Here is what is required: <li>To generate LaTeX documentation or formulas in HTML you need the tools: <code>latex</code>, <code>dvips</code> and <code>gswin32</code>. To get these working under Windows - install the fpTeX distribution You can download it at: + install the fpTeX distribution. You can download it at: ftp://ctan.tug.org/tex-archive/systems/win32/web2c/fptex-0.3/ Make sure the tools are available from a dos box, by adding the @@ -409,7 +410,7 @@ Here is what is required: For your information, the LaTeX is freely available set of so called macros and styles on the top of the famous TeX program (by famous Donald Knuth) and the accompanied utilities (all - available for free). It is used to for high quality + available for free). It is used for high quality typesetting. The result -- in the form of so called <code>DVI</code> (DeVice Independent) file -- can be printed or displayed on various devices preserving exactly the same look up @@ -457,7 +458,7 @@ Compilation is now done by performing the following steps: of the documentation into PostScript or PDF. It is \e not needed for compiling the doxygen's binaries. -<li>goto the doxygen root dir and type: +<li>Go to the doxygen root dir and type: \verbatim make.bat msvc @@ -486,10 +487,10 @@ Compilation is now done by performing the following steps: nmake \endverbatim - The generated docs int HTML are located in the <code>..\html</code> + The generated HTML docs are located in the <code>..\html</code> subdirectory. - The sources for LaTeX documentation are located in <code>..\latex</code> + The sources for LaTeX documentation are located in the <code>..\latex</code> subdirectory. From those sources, the DVI, PostScript, and PDF documentation can be generated. </ol> diff --git a/doc/maintainers.txt b/doc/maintainers.txt index bddd9d4..11a231a 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -30,6 +30,7 @@ French Christophe Bordeux: bordeux@lig.di.epfl.ch German +Jens Seidel: jensseidel@users.sourceforge.net Jens Breitenstein: Jens.Breitenstein@tlc.de Hungarian @@ -60,6 +61,9 @@ Alexandru Iosup: aiosup@yahoo.com Russian Alexandr Chelpanov: cav@cryptopro.ru +Slovak +Stanislav Kudlac: qwerty1@pobox.sk + Slovene Matjaz Ostroversnik: matjaz.ostroversnik@zrs-tk.si diff --git a/doc/output.doc b/doc/output.doc index 1c6508f..8e427a9 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -39,14 +39,14 @@ The following output formats are \e indirectly supported by doxygen: <dt><b>Compressed HTML</b> (a.k.a. Windows 98 help) <dd>Generated by Microsoft's HTML Help workshop from the HTML output if \c GENERATE_HTMLHELP is set to \c YES. -<dt><b>Postscript</b> +<dt><b>PostScript</b> <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by running <code>make ps</code> in the output directory. For the best results \c PDF_HYPERLINKS should be set to \c NO. <dt><b>PDF</b>\htmlonly \endhtmlonly <dd>Generated from the \f$\mbox{\LaTeX}\f$ output by running <code>make pdf</code> in the output directory. - In order to get hyperlinks in the pdf file, + In order to get hyperlinks in the PDF file, \c PDF_HYPERLINKS should be set to \c YES in the configuration file. </dl> diff --git a/doc/starting.doc b/doc/starting.doc index 927d2a0..b307788 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -105,7 +105,7 @@ doxygen <config-file> Doxygen will create a \c html, \c rtf, \c latex and/or \c man directory inside the output directory. -As the names suggest the \c html directory contain the +As the names suggest these directories contain the generated documentation in HTML, RTF, \f$\mbox{\LaTeX}\f$ and Unix-Man page format. @@ -132,12 +132,12 @@ 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 (provided that you have a make tool called <code>make</code> of course). This file can then be viewed using \c xdvi or -converted into a postscript file \c refman.ps by +converted into a PostScript file \c refman.ps by typing <code>make ps</code> (this requires <code>dvips</code>). To put 2 pages on one physical page use <code>make ps_2on1</code> instead. -The resulting 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. +The resulting 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. Conversion to PDF is also possible if you have installed the ghostscript interpreter; just type <code>make pdf</code> (or <code>make pdf_2on1</code>). To get the best results for PDF output you should set |