doxygen_manual-1.8.1 (1035109), страница 20
Текст из файла (страница 20)
All formats are optimized for ease of reading.Furthermore, compressed HTML can be generated from HTML output using Microsoft’s HTML Help Workshop (Windows only) and PDF can be generated from the LATEX output.• Support for various third party help formats including HTML Help, docsets, Qt-Help, and eclipse help.• Includes a full C preprocessor to allow proper parsing of conditional code fragments and to allow expansionof all or part of macros definitions.• Automatically detects public, protected and private sections, as well as the Qt specific signal and slots sections.
Extraction of private class members is optional.• Automatically generates references to documented classes, files, namespaces and members. Documentationof global functions, global variables, typedefs, defines and enumerations is also supported.86Features• References to base/super classes and inherited/overridden members are generated automatically.• Includes a fast, rank based search engine to search for strings or words in the class and member documentation (PHP based).• Includes an Javascript based live search feature to search for symbols as you type (for small to medium sizedprojects).• You can type normal HTML tags in your documentation.
Doxygen will convert them to their equivalent LATEX,RTF, and man-page counterparts automatically.• Allows references to documentation generated for other (doxygen documented) projects (or another part ofthe same project) in a location independent way.• Allows inclusion of source code examples that are automatically cross-referenced with the documentation.• Inclusion of undocumented classes is also supported, allowing to quickly learn the structure and interfaces ofa (large) piece of code without looking into the implementation details.• Allows automatic cross-referencing of (documented) entities with their definition in the source code.• All source code fragments are syntax highlighted for ease of reading.• Allows inclusion of function/member/class definitions in the documentation.• All options are read from an easy to edit and (optionally) annotated configuration file.• Documentation and search engine can be transferred to another location or machine without regenerating thedocumentation.• Supports many different character encodings and uses UTF-8 internally and for the generated output.• Doxygen can generate a layout which you can use and edit to change the layout of each page.• There more than a 100 configurable options to fine-tune the output.• Can cope with large projects easily.Although doxygen can now be used in any project written in a language that is supported by doxygen, initially it wasspecifically designed to be used for projects that make use of Qt Software’s Qt toolkit.
I have tried to makedoxygen ‘Qt-compatible’. That is: Doxygen can read the documentation contained in the Qt source code and createa class browser that looks quite similar to the one that is generated by Qt Software. Doxygen understands the C++extensions used by Qt such as signals and slots and many of the markup commands used in the Qt sources.Doxygen can also automatically generate links to existing documentation that was generated with Doxygen or withQt’s non-public class browser generator. For a Qt based project this means that whenever you refer to members orclasses belonging to the Qt toolkit, a link will be generated to the Qt documentation. This is done independent ofwhere this documentation is located!Generated by DoxygenChapter 18Doxygen usageDoxygen is a command line based utility.
Calling doxygen with the -help option at the command line will giveyou a brief description of the usage of the program.All options consist of a leading character -, followed by one character and one or more arguments depending onthe option.To generate a manual for your project you typically need to follow these steps:1. You document your source code with special documentation blocks (see section Special comment blocks).2. You generate a configuration file (see section Configuration) by calling doxygen with the -g option:doxygen -g <config_file>3. You edit the configuration file so it matches your project. In the configuration file you can specify the inputfiles and a lot of optional information.4.
You let doxygen generate the documentation, based on the settings in the configuration file:doxygen <config_file>If you have a configuration file generated with an older version of doxygen, you can upgrade it to the current versionby running doxygen with the -u option.doxygen -u <config_file>All configuration settings in the original configuration file will be copied to the new configuration file. Any new optionswill have their default value.
Note that comments that you may have added in the original configuration file will belost.18.1Fine-tuning the outputIf you want to fine-tune the way the output looks, doxygen allows you generate default style sheet, header, andfooter files that you can edit afterwards:• For HTML output, you can generate the default header file (see HTML_HEADER), the default footer (seeHTML_FOOTER), and the default style sheet (see HTML_STYLESHEET), using the following command:doxygen -w html header.html footer.html stylesheet.css <config_file>The config_file is optional.
When omitted doxygen will search for a file named Doxyfile and process that.When this is also not found it will used the default settings.• For LaTeX output, you can generate the first part of refman.tex (see LATEX_HEADER) and the stylesheet included by that header (normally doxygen.sty), using:88Doxygen usagedoxygen -w latex header.tex doxygen.styIf you need non-default options (for instance to use pdflatex) you need to make a config file with those optionsset correctly and then specify that config file as the third argument.• For RTF output, you can generate the default style sheet file (see RTF_STYLESHEET_FILE) using:doxygen -w rtf rtfstyle.cfgWarningWhen using a custom header you are responsible for the proper inclusion of any scripts and style sheets thatdoxygen needs, which is dependent on the configuration options and may changes when upgrading to a newdoxygen release.Note• If you do not want documentation for each item inside the configuration file then you can use the optional-s option.
This can use be used in combination with the -u option, to add or strip the documentationfrom an existing configuration file. Please use the -s option if you send me a configuration file as part ofa bug report!• To make doxygen read/write to standard input/output instead of from/to a file, use - for the file name.Generated by DoxygenChapter 19Doxywizard usageDoxywizard is a GUI front-end for configuring and running doxygen.When you start doxywizard it will display the main window (the actual look depends on the OS used).The windows shows the steps to take to configure and run doxygen.
The first step is to choose one of the ways toconfigure doxygen.Wizard Click this button to quickly configure the most important settings and leave the rest of the options to theirdefaults.Expert Click this button to gain access to the full range of configuration options.Load Click this button to load an existing configuration file from disk.Note that you can select multiple buttons in a row, for instance to first configure doxygen using the Wizard and thenfine tune the settings via the Expert.After doxygen is configured you need to save the configuration as a file to disk. This second step allows doxygento use the configuration and has the additional advantage that the configuration can be reused to run doxygen withthe same settings at a later point in time.Since some configuration options may use relative paths, the next step is to select a directory from which to rundoxygen.
This is typically the root of the source tree and will most of the time already be filled in correctly.Once the configuration file is saved and the working directory is set, you can run doxygen based on the selectedsettings. Do this by pressing the "Start" button. Once doxygen runs you can cancel it by clicking the same buttonagain. The output produced by doxygen is captured and shown in a log window. Once doxygen finishes, the logcan be saved as a text file.The Wizard DialogIf you select the Wizard button in step 1, then a dialog with a number of tabs will appear.The fields in the project tab speak for themselves.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
