diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/arch.doc | 6 | ||||
| -rw-r--r-- | doc/config.doc | 59 | ||||
| -rw-r--r-- | doc/docblocks.doc | 49 | ||||
| -rw-r--r-- | doc/features.doc | 12 | ||||
| -rw-r--r-- | doc/grouping.doc | 7 | ||||
| -rw-r--r-- | doc/install.doc | 11 | ||||
| -rw-r--r-- | doc/language.doc | 4 | ||||
| -rw-r--r-- | doc/lists.doc | 11 | ||||
| -rw-r--r-- | doc/starting.doc | 110 | ||||
| -rw-r--r-- | doc/translator_report.txt | 19 | ||||
| -rw-r--r-- | doc/trouble.doc | 4 |
11 files changed, 200 insertions, 92 deletions
diff --git a/doc/arch.doc b/doc/arch.doc index ca0417c..a5ace10 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -31,9 +31,9 @@ The following sections explain the steps above in more detail. The configuration file that controls the settings of a project is parsed and the settings are stored in the singleton class \c Config -in \c src/config.h. The parser itself is written using \c flex and can be -found in \c src/config.l. This parser is also used directly by \c doxywizard, -so it is put in a separate library. +in <code>src/config.h</code>. The parser itself is written using \c flex +and can be found in <code>src/config.l</code>. This parser is also used +directly by \c doxywizard, so it is put in a separate library. Each configuration option has one of 5 possible types: \c String, \c List, \c Enum, \c Int, or \c Bool. The values of these options are diff --git a/doc/config.doc b/doc/config.doc index e29233e..891f148 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -61,6 +61,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_alphabetical_index ALPHABETICAL_INDEX \refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC \refitem cfg_binary_toc BINARY_TOC +\refitem cfg_builtin_stl_support BUILTIN_STL_SUPPORT \refitem cfg_brief_member_desc BRIEF_MEMBER_DESC \refitem cfg_call_graph CALL_GRAPH \refitem cfg_case_sense_names CASE_SENSE_NAMES @@ -206,6 +207,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_treeview_width TREEVIEW_WIDTH \refitem cfg_uml_look UML_LOOK \refitem cfg_use_htags USE_HTAGS +\refitem cfg_use_pdflatex USE_PDFLATEX \refitem cfg_use_windows_encoding USE_WINDOWS_ENCODING \refitem cfg_verbatim_headers VERBATIM_HEADERS \refitem cfg_warn_format WARN_FORMAT @@ -343,7 +345,8 @@ followed by the descriptions of the tags grouped by category. path to strip. \anchor cfg_strip_from_inc_path -<dt>\c STRIP_FROM_INC_PATH +<dt>\c STRIP_FROM_INC_PATH <dd> + \addindex STRIP_FROM_INC_PATH The \c STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the path mentioned in the documentation of a class, which tells the reader which header file to include in order to use a class. @@ -378,6 +381,24 @@ followed by the descriptions of the tags grouped by category. comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like the Qt-style comments. +\anchor cfg_builtin_stl_support +<dt>\c BUILTIN_STL_SUPPORT <dd> + \addindex BUILTIN_STL_SUPPORT + If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to + include (a tag file for) the STL sources as input, then you should + set this tag to \c YES in order to let doxygen match functions declarations and + definitions whose arguments contain STL classes (e.g. func(std::string); v.s. + func(std::string) {}). This also make the inheritance and collaboration + diagrams that involve STL classes more complete and accurate. + +\anchor cfg_distribute_group_doc +<dt>\c DISTRIBUTE_GROUP_DOC <dd> + \addindex DISTRIBUTE_GROUP_DOC + If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC + tag is set to YES, then doxygen will reuse the documentation of the first + member in the group (if any) for the other members of the group. By default + all members of a group must be documented explicitly. + \anchor cfg_multiline_cpp_is_brief <dt>\c MULTILINE_CPP_IS_BRIEF <dd> \addindex MULTILINE_CPP_IS_BRIEF @@ -404,14 +425,6 @@ followed by the descriptions of the tags grouped by category. member inherits the documentation from any documented member that it re-implements. -\anchor cfg_distribute_group_doc -<dt>\c DISTRIBUTE_GROUP_DOC <dd> - \addindex DISTRIBUTE_GROUP_DOC - If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC - tag is set to YES, then doxygen will reuse the documentation of the first - member in the group (if any) for the other members of the group. By default - all members of a group must be documented explicitly. - \anchor cfg_separate_member_pages <dt>\c SEPARATE_MEMBER_PAGES <dd> \addindex SEPARATE_MEMBER_PAGES @@ -453,10 +466,10 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_optimize_output_java <dt>\c OPTIMIZE_OUTPUT_JAVA <dd> \addindex OPTIMIZE_OUTPUT_JAVA - Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources - only. Doxygen will then generate output that is more tailored for Java. - For instance, namespaces will be presented as packages, qualified scopes - will look different, etc. + Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or + Python sources only. Doxygen will then generate output that is more tailored + for that language. For instance, namespaces will be presented as packages, + qualified scopes will look different, etc. \anchor cfg_subgrouping <dt>\c SUBGROUPING <dd> @@ -683,18 +696,20 @@ function's detailed documentation block. \anchor cfg_warn_if_doc_error <dt>\c WARN_IF_DOC_ERROR <dd> + \addindex WARN_IF_DOC_ERROR If \c WARN_IF_DOC_ERROR is set to \c YES, doxygen will generate warnings for potential errors in the documentation, such as not documenting some parameters in a documented function, or documenting parameters that don't exist or using markup commands wrongly. \anchor cfg_warn_no_paramdoc -<dt>\c WARN_NO_PARAMDOC -This \c WARN_NO_PARAMDOC option can be abled to get warnings for -functions that are documented, but have no documentation for their parameters -or return value. If set to \c NO (the default) doxygen will only warn about -wrong or incomplete parameter documentation, but not about the absence of -documentation. +<dt>\c WARN_NO_PARAMDOC <dd> + \addindex WARN_NO_PARAMDOC + This \c WARN_NO_PARAMDOC option can be abled to get warnings for + functions that are documented, but have no documentation for their parameters + or return value. If set to \c NO (the default) doxygen will only warn about + wrong or incomplete parameter documentation, but not about the absence of + documentation. \anchor cfg_warn_format <dt>\c WARN_FORMAT <dd> @@ -749,7 +764,7 @@ documentation. popen()) the command <code>command input-file</code>, where \c command is the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name of an input file provided by doxygen. - Whatever the progam writes to standard output is used as the file version. + Whatever the program writes to standard output is used as the file version. Example of using a shell script as a filter for Unix: \verbatim @@ -1243,12 +1258,12 @@ EXTRA_PACKAGES = times \addindex PDF_HYPERLINKS 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). + is generated is prepared for conversion to PDF (using ps2pdf or pdflatex). 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. -\anchor cfg_latex_pdflatex +\anchor cfg_use_pdflatex <dt>\c USE_PDFLATEX <dd> \addindex LATEX_PDFLATEX diff --git a/doc/docblocks.doc b/doc/docblocks.doc index b1ad2dc..a0132d8 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -18,9 +18,11 @@ \section specialblock Special documentation blocks -A special documentation block is a C or C++ comment block with some +A special documentation block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece of documentation that -needs to end up in the generated documentation. +needs to end up in the generated documentation. For Python code there is +a different comment convention, which can be found in section +\ref pythonblocks For each code item there are two types of descriptions, which together form the documentation: a \e brief description and \e detailed @@ -168,7 +170,7 @@ detailed description, the one before the \e definition is preferred and the one before the declaration will be ignored. Here is an example of a documented piece of C++ code using the Qt style: -\verbinclude qtstyle.cpp +\include 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. @@ -201,7 +203,7 @@ Here is an example: Here is the same piece of code as shown above, this time documented using the JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES: -\verbinclude jdstyle.cpp +\include 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. @@ -260,7 +262,7 @@ only the \< indicates that the member is located in front of the block instead of after the block. Here is an example of the use of these comment blocks: -\verbinclude afterdoc.h +\include 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. @@ -313,6 +315,7 @@ Other structural commands are: <li>\c \\fn to document a function. <li>\c \\var to document a variable or typedef or enum value. <li>\c \\def to document a \#define. +<li>\c \\typedef to document a type definition. <li>\c \\file to document a file. <li>\c \\namespace to document a namespace. <li>\c \\package to document a Java package. @@ -335,7 +338,7 @@ or a \verbatim /** @file */ \endverbatim line in this file. Here is an example of a C header named \c structcmd.h that is documented using structural commands: -\verbinclude structcmd.h +\include structcmd.h \htmlonly Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd_8h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. @@ -351,6 +354,40 @@ using structural commands: in comment blocks which are place in front of a function. This is clearly a case where the \\fn command is redundant and will only lead to problems. +\section pythonblocks Special documentation blocks in Python + +For Python there is a standard way of documenting the code using +so called documentation strings. Such strings are stored in \c __doc__ +and can be retrieved at runtime. Doxygen will extract such comments +and assume they have to be represented in a preformatted way. + +\include docstring.py + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/docstring/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + +Note that in this case none of doxygen's \ref cmd_intro "special commands" +are supported. + +There is also another way to document Python code using comments that +start with "##". These type of comment blocks are more in line with the +way documentation blocks work for the other languages support doxygen +and this also allows the use of special commands. + +Here is the same example again but now using doxygen style comments: + +\include pyexample.py + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/pyexample/html/index.html">here</a> + for the corresponding HTML documentation that is generated by doxygen. + \endhtmlonly + +Since python looks more like Java than like C or C++, you should set +\ref cfg_optimize_output_java "OPTMIZE_OUTPUT_JAVA" to \c YES in the +config file. + + \htmlonly Go to the <a href="lists.html">next</a> section or return to the <a href="index.html">index</a>. diff --git a/doc/features.doc b/doc/features.doc index e3c76ad..871242d 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -21,20 +21,22 @@ <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/C++, Java, (Corba and Microsoft) Java, +<li>Supports C/C++, Java, (Corba and Microsoft) Java, Python, IDL, C#, Objective-C and to some extent D and PHP sources. -<li>Supports documentation of files, namespaces, classes, structs, unions, - templates, variables, functions, typedefs, enums and defines. +<li>Supports documentation of files, namespaces, packages, classes, + structs, unions, templates, variables, functions, typedefs, enums and + defines. <li>JavaDoc (1.1), Qt-Doc, and ECMA-334 (C# spec.) compatible. <li>Automatically generates class and collaboration diagrams in HTML (as clickable 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. -<li>Allows you to put documentation in the header file (before the +<li>Flexible comment placement: Allows you to put documentation in the + header file (before the declaration of an entity), source file (before the definition of an entity) or in a separate file. -<li>Can generate a list of all members of a class (including any inherited +<li>Generates 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) simultaneously diff --git a/doc/grouping.doc b/doc/grouping.doc index 2b896e5..6e942ce 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -22,7 +22,7 @@ for each group. These groups are called \ref modules "'modules'" in the document The second mechanism works within a member list of some compound entity, and is refered to as a \ref memgroup "'member groups'". For \ref cmdpage "pages" there is a third grouping mechanism referred to -a \ref subpaging "subpaging". +as \ref subpaging "subpaging". \section modules Modules @@ -217,4 +217,9 @@ the same time makes page B a subpage of A. This has the effect of making two groups GA and GB, where GB is part of GA, page A is put in group GA, and page B is put in group GB. +\htmlonly +Go to the <a href="formulas.html">next</a> section or return to the + <a href="index.html">index</a>. +\endhtmlonly + */ diff --git a/doc/install.doc b/doc/install.doc index 2bea43f..8fb1f6a 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -184,7 +184,7 @@ Compilation is now done by performing the following steps: This is sufficient to use doxygen. \note You need the GNU install tool for this to work (it is part of - the fileutils package). Other install tools may put the binaries in + the coreutils package). Other install tools may put the binaries in the wrong directory! If you have a RPM or DEP package, then please follow the @@ -549,14 +549,15 @@ features: If you want to use MikTeX then you need to select at least the medium size installation. For really old versions of MikTex or minimal installations, you may need to download the fancyhdr package separately. - You can find it at: - ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/supported/fancyhdr/ + You can find it in the + <a href="ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/supported/fancyhdr/"> + contrib/supported</a> directory of the tex archives. <li>If you want to generate compressed HTML help (see \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the config file, then you need the Microsoft HTML help workshop. - You can download it at: - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp + You can download it from + <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">Microsoft</a>. <li><a href="http://www.research.att.com/sw/tools/graphviz/"> the Graph visualization toolkit version 1.8.10</a><br> diff --git a/doc/language.doc b/doc/language.doc index df9d7a6..061c788 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -78,7 +78,7 @@ when the translator was updated. <td>Chinese Traditional</td> <td>Daniel YC Lin<br>Gary Lee</td> <td>daniel at twpda dot com<br>garylee at ecosine dot com dot tw</td> - <td>1.3.8</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Croatian</td> @@ -273,7 +273,7 @@ when the translator was updated. Chinese & Li Daobing & {\tt\tiny lidaobing@gmail.com} & 1.4.1 \\ ~ & Wei Liu & {\tt\tiny liuwei@asiainfo.com} & ~ \\ \hline - Chinese Traditional & Daniel YC Lin & {\tt\tiny daniel@twpda.com} & 1.3.8 \\ + Chinese Traditional & Daniel YC Lin & {\tt\tiny daniel@twpda.com} & up-to-date \\ ~ & Gary Lee & {\tt\tiny garylee@ecosine.com.tw} & ~ \\ \hline Croatian & Boris Bralo & {\tt\tiny boris.bralo@zg.htnet.hr} & up-to-date \\ diff --git a/doc/lists.doc b/doc/lists.doc index 9da03d2..649d83c 100644 --- a/doc/lists.doc +++ b/doc/lists.doc @@ -1,13 +1,13 @@ /*! \page lists Lists -Doxygen has a number of ways to create lists of items. +Doxygen provides a number of ways to create lists of items. <b>Using dashes</b> By putting a number of column-aligned minus signs at the start of a line, a bullet list will automatically be generated. Numbered lists can also be generated by using a minus followed by a hash. - Nesting of lists is allowed.<p> + Nesting of lists is allowed and is based on indentation of the items.<p> Here is an example: \verbatim /*! @@ -38,8 +38,9 @@ Doxygen has a number of ways to create lists of items. More text here. -If you use tabs within lists, please make sure that \ref cfg_tab_size "TAB_SIZE" in the -configuration file is set to the correct tab size. +If you use tabs for indentation within lists, please make sure +that \ref cfg_tab_size "TAB_SIZE" in the configuration file is set to +the correct tab size. You can end a list by starting a new paragraph or by putting a dot (.) on an empty line at the same indent level as the @@ -98,7 +99,7 @@ Here is the above example with HTML commands: */ \endverbatim -\note The indentation here is not important. +\note In this case the indentation is not important. <b>Using \\arg or \@li</b> diff --git a/doc/starting.doc b/doc/starting.doc index 7410208..d0af1ec 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -26,11 +26,14 @@ for which you do not have the sources. See section \ref doxytag_usage for more detailed usage information. Optionally, the executable \c doxywizard can be used, which is a -graphical front-end for editing the configuration file that is used by -doxygen. +\ref doxywizard_usage "graphical front-end" for editing the configuration file +that is used by doxygen and for running doxygen in a graphical environment. +For Mac OS X doxywizard will be started by clicking on the Doxygen application +icon. The following figure shows the relation between the tools and the flow -of information between them: +of information between them (it looks complex but that's only because it +tries to be complete): \image html infoflow.gif "Doxygen information flow" \image latex infoflow.eps "Doxygen information flow" width=14cm @@ -55,7 +58,7 @@ name \<config-file\> already exists, doxygen will rename it to \<config-file\>.bak before generating the configuration template. If you use <code>-</code> (i.e. the minus sign) as the file name then doxygen will try to read the configuration file from standard -input (<code>stdin</code>). +input (<code>stdin</code>), which can be useful for scripting. 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: @@ -78,8 +81,8 @@ and header files, you can leave the current directory. If you have a larger project consisting of a source directory or tree -you should put the root directory or -directories after the \ref cfg_input "INPUT" tag, and add one or more file +you should assign the root directory or +directories to the \ref cfg_input "INPUT" tag, and add one or more file patterns to the \ref cfg_file_patterns "FILE_PATTERNS" tag (for instance <code>*.cpp *.h</code>). Only files that match one of the patterns will be parsed (if the patterns are omitted a list of @@ -92,17 +95,21 @@ To omit all \c test directories from a source tree for instance, one could use: \verbatim EXCLUDE_PATTERNS = */test/* \endverbatim -Doxygen normally parses files if they are C or C++ sources. If a file -has a <code>.idl</code> or <code>.odl</code> extension it is treated as an -IDL file. If it has a <code>.java</code> extension it is treated as a file -written in Java. Files ending with <code>.cs</code> are treated as C# files. -Finally, files with the extensions <code>.php</code>, <code>.php4</code>, +Doxygen looking at the file's extension to determine how to parse a file. +If a file has an <code>.idl</code> or <code>.odl</code> extension it is +treated as an IDL file. If it has a <code>.java</code> extension it is +treated as a file written in Java. Files ending with <code>.cs</code> are +treated as C# files and the <code>.py</code> extension selects the +Python parser. Finally, files with the extensions <code>.php</code>, <code>.php4</code>, <code>.inc</code> or <code>.phtml</code> are treated as PHP sources. +Any other extension is parsed as if it is a C/C++ file, where files that +end with <code>.m</code> are treated as Objective-C source files. \anchor extract_all 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 +what the structure is and how the documented result would look like. +To do so, you must set the \ref cfg_extract_all "EXTRACT_ALL" tag in the configuration file to \c YES. Then, doxygen will pretend everything in your sources is documented. Please note that as a consequence warnings about undocumented members @@ -124,46 +131,91 @@ To generate the documentation you can now enter: doxygen <config-file> \endverbatim -Doxygen will create a \c html, \c rtf, \c latex and/or \c man directory inside -the output directory. +Depending on your settings doxygen will create \c html, \c rtf, +\c latex, \c xml and/or \c man directories inside the output directory. As the names suggest these directories contain the -generated documentation in HTML, RTF, \f$\mbox{\LaTeX}\f$ and Unix-Man page -format. +generated documentation in HTML, RTF, \f$\mbox{\LaTeX}\f$, XML and +Unix-Man page format. The default output directory is the directory in which \c doxygen -is started. The directory to which the output is written can be changed -using the \ref cfg_output_directory "OUTPUT_DIRECTORY", +is started. The root directory to which the output is written can be changed +using the \ref cfg_output_directory "OUTPUT_DIRECTORY". The format specific +directory within the output directory can be selected using the \ref cfg_html_output "HTML_OUTPUT", \ref cfg_rtf_output "RTF_OUTPUT", -\ref cfg_latex_output "LATEX_OUTPUT", and \ref cfg_man_output "MAN_OUTPUT" +\ref cfg_latex_output "LATEX_OUTPUT", \ref cfg_xml_output "XML_OUTPUT", +and \ref cfg_man_output "MAN_OUTPUT" tags of the configuration file. If the output directory does not exist, -\c doxygen will try to create it for you. +\c doxygen will try to create it for you (but it will \e not try to create +a whole path recursively, like <code>mkdir -p</code> does). +\subsection html_out HTML output \addindex browser 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.61 to test the generated output). -\addindex LaTeX +(I'm using Mozilla, Safari, Konqueror, and sometimes IE6 to test the +generated output). + +Some of the features the HTML section (such as +\ref cfg_generate_treeview "GENERATE_TREEVIEW") require a browser that +supports DHTML and Javascript. +If you plan to use the search engine (see +\ref cfg_searchengine "SEARCHENGINE"), you should view the HTML output +via a PHP enable web server (e.g. apache with the PHP module installed). + +\subsection latex_out LaTeX 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.9 -that contains \f$\mbox{\TeX}\f$ version 3.14159). To simplify the process -of compiling the generated +a \f$\mbox{\LaTeX}\f$ compiler (I use a recent teTeX distribution). +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 (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 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. + 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 -the \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" tag to \c YES. - +the \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" +and \ref cfg_use_pdflatex "USE_PDFLATEX" tags to \c YES. + +\subsection rtf_out RTF output +\addindex RTF +Doxygen combines the RTF output to a single file called refman.rtf. This +file is optimized for importing into the Microsoft Word. Certain information +is encoded using field. To show the actual value you need to +select all (Edit - select all) and then toggle fields (right click and select +the option from the drop down menu). + +\subsection xml_out XML output +\addindex XML +The XML output consists of a structured "dump" of the information gathered +by doxygen. Each compound (class/namespace/file/...) has its own XML file +and there is also an index file called index.xml. + +A file called combine.xslt +XSLT script is also generated and can be used to combine all XML files +into a single file. + +Doxygen also generates two XML schema files index.xsd +(for the index file) and compound.xsd (for the compound files). +This schema file describes the possible elements, their attributes and +how they are structured, i.e. it the describes the grammar of the XML +files and can be used for validation or to steer XSLT scripts. + +In the addon/doxmlparser directory you can find a parser library for reading +the XML output produced by doxygen in an incremental way +(see addon/doxmlparser/include/doxmlintf.h for the interface of the library) + +\subsection man_out Man page output 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 \c MANPATH environment variable). Note that there are some limitations to the @@ -215,7 +267,9 @@ During parsing the following steps take place: <li> All resulting blank lines are treated as a paragraph separators. This saves you from placing new-paragraph commands yourself in order to make the generated documentation readable. -<li> Links are created for words corresponding to documented classes. +<li> Links are created for words corresponding to documented classes + (unless the word is preceded by a \%; then the word will not be linked and + the \% sign is removed). <li> Links to members are created when certain patterns are found in the text. See section \ref autolink for more information on how the automatic link generation works. diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 325429d..dc2c164 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -8,7 +8,7 @@ German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean (+En), Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. -Of them, 17 translators are up-to-date, 14 translators are based on +Of them, 18 translators are up-to-date, 13 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -20,6 +20,7 @@ still may be some details listed even for them: TranslatorAfrikaans TranslatorBrazilian -- Remove the obsolete methods (never used). TranslatorCatalan + TranslatorChinesetraditional -- Remove the obsolete methods (never used). TranslatorCroatian TranslatorCzech TranslatorDutch -- Remove the obsolete methods (never used). @@ -49,7 +50,6 @@ must be implemented to become up-to-date: TranslatorJapanese 1.3.9 7 methods to implement TranslatorDanish 1.3.9 7 methods to implement TranslatorSpanish 1.3.8 8 methods to implement - TranslatorChinesetraditional 1.3.8 8 methods to implement TranslatorPortuguese 1.3.3 12 methods to implement TranslatorSlovak 1.2.18 21 methods to implement TranslatorSlovene 1.2.16 23 methods to implement @@ -99,21 +99,10 @@ TranslatorChinese (TranslatorAdapter_1_4_1) 1 method to implement virtual QCString trOverloadText() -TranslatorChinesetraditional (TranslatorAdapter_1_3_8) 8 methods to implement +TranslatorChinesetraditional (Translator) ---------------------------- - Implements 184 of the required methods. - - Missing methods (should be implemented): - - virtual QCString trOverloadText() - virtual QCString trDirIndex() - virtual QCString trDirDocumentation() - virtual QCString trDirectories() - virtual QCString trDirDescription() - virtual QCString trSourceFile(QCString & filename) - virtual QCString trDirReference(const char * dirName) - virtual QCString trDir(bool first_capital, bool singular) + Implements 192 of the required methods. Obsolete methods (should be removed, never used): diff --git a/doc/trouble.doc b/doc/trouble.doc index e8880b3..312c163 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -134,5 +134,9 @@ For patches please use one file please tar or zip everything, so I only have to save and download one file. +\htmlonly +Return to the <a href="index.html">index</a>. +\endhtmlonly + */ |