doxygen_manual-1.8.1 (Методичка, задание и документация на ЛР №7), страница 6

use c:\tools)Now start a new command shell and typecd c:\toolsgunzip doxygen-x.y.z.src.tar.gztar xvf doxygen-x.y.z.src.tarto unpack the sources.Now your environment is setup to build doxygen.Inside the doxygen-x.y.z directory you will find a winbuild directory containing a Doxygen.sln file. Openthis file in Visual Studio. You can now build the Release or Debug flavor of Doxygen by right-clicking the project inthe solutions explorer, and selecting Build.Note that compiling Doxywizard currently requires Qt version 4 (see http://qt.nokia.com/products/platform/qt-forAlso read the next section for additional tools you may need to install to run doxygen with certain features enabled.1.5Installing the binaries on WindowsDoxygen comes as a self-installing archive, so installation is extremely simple.

Just follow the dialogs.After installation it is recommended to also download and install GraphViz (version 2.20 or better is highly recommended). Doxygen can use the dot tool of the GraphViz package to render nicer diagrams, see the HAVE_DOToption in the configuration file.If you want to produce compressed HTML files (see GENERATE_HTMLHELP) in the config file, then you need theMicrosoft HTML help workshop. You can download it from Microsoft.If you want to produce Qt Compressed Help files (see QHG_LOCATION) in the config file, then you need qhelpgenerator which is part of Qt. You can download Qt from Qt Software Downloads.In order to generate PDF output or use scientific formulas you will also need to install LaTeX and Ghostscript.For LaTeX a number of distributions exists. Popular ones that should work with doxygen are MikTex and XemTex.Ghostscript can be downloaded from Sourceforge.After installing LaTeX and Ghostscript you’ll need to make sure the tools latex.exe, pdflatex.exe, and gswin32c.exe are present in the search path of a command box.

Follow these instructions if you are unsure and run thecommands from a command box to verify it works.Generated by Doxygen121.6InstallationTools used to develop doxygenDoxygen was developed and tested under Linux & MacOSX using the following open-source tools:• GCC version 3.3.6 (Linux) and 4.0.1 (MacOSX)• GNU flex version 2.5.33 (Linux) and 2.5.4 (MacOSX)• GNU bison version 1.75• GNU make version 3.80• Perl version 5.8.1• VIM version 6.2• Firefox 1.5• Trolltech’s tmake version 1.3 (included in the distribution)• teTeX version 2.0.2• CVS 1.12.12Generated by DoxygenChapter 2Getting StartedThe executable doxygen is the main program that parses the sources and generates the documentation.

Seesection Doxygen usage for more detailed usage information.Optionally, the executable doxywizard can be used, which is a graphical front-end for editing the configurationfile that is used by doxygen and for running doxygen in a graphical environment. For Mac OS X doxywizard will bestarted by clicking on the Doxygen application icon.The following figure shows the relation between the tools and the flow of information between them (it looks complexbut that’s only because it tries to be complete):Doxywizardgenerate/editYour applicationXML filesreaddoxmlparser libConfig fileDoxyfileLayout filemake psgenerategenerateupdatereadLatex files+Makefilepostscriptlatexmake pdfPDFreadSourcescustomoutputDoxygenreadreadgenerateMan pagesCustom− headers− footers− imagesTag file(s)Windows onlyrefman.rtfHTMLpagesimportreadFigure 2.1: Doxygen information flowdocMS−WordchmHTML Help Workshop142.1Getting StartedStep 0: Check if doxygen supports your programming languageFirst, assure that your programming language has a reasonable chance of being recognized by Doxygen.

Theselanguages are supported by default: C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran, andD. It is possible to configure certain file type extensions to use certain parsers: see the Configuration/ExtensionMappings for details. Also, completely different languages can be supported by using preprocessor programs: seethe Helpers page for details.2.2Step 1: Creating a configuration fileDoxygen uses a configuration file to determine all of its settings. Each project should get its own configuration file.A project can consist of a single source file, but can also be an entire source tree that is recursively scanned.To simplify the creation of a configuration file, doxygen can create a template configuration file for you.

To do thiscall doxygen from the command line with the -g option:doxygen -g <config-file>where <config-file> is the name of the configuration file. If you omit the file name, a file named Doxyfile willbe created. If a file with the name <config-file> already exists, doxygen will rename it to <config-file>.bak beforegenerating the configuration template. If you use - (i.e. the minus sign) as the file name then doxygen will try toread the configuration file from standard input (stdin), which can be useful for scripting.The configuration file has a format that is similar to that of a (simple) Makefile.

It consists of a number of assignments(tags) of the form:TAGNAME = VALUE orTAGNAME = VALUE1 VALUE2 ...You can probably leave the values of most tags in a generated template configuration file to their default value. Seesection Configuration for more details about the configuration file.If you do not wish to edit the config file with a text editor, you should have a look at doxywizard, which is a GUIfront-end that can create, read and write doxygen configuration files, and allows setting configuration options byentering them via dialogs.For a small project consisting of a few C and/or C++ source and header files, you can leave INPUT tag empty anddoxygen will search for sources in the current directory.If you have a larger project consisting of a source directory or tree you should assign the root directory or directoriesto the INPUT tag, and add one or more file patterns to the FILE_PATTERNS tag (for instance ∗.cpp ∗.h).

Onlyfiles that match one of the patterns will be parsed (if the patterns are omitted a list of typical patterns is used for thetypes of files doxygen supports). For recursive parsing of a source tree you must set the RECURSIVE tag to YES.To further fine-tune the list of files that is parsed the EXCLUDE and EXCLUDE_PATTERNS tags can be used. Toomit all test directories from a source tree for instance, one could use:EXCLUDE_PATTERNS = */test/*Doxygen looks at the file’s extension to determine how to parse a file, using the following table:Generated by Doxygen2.3 Step 2: Running doxygen15Extension.idl.ddl.odl.java.cs.d.php.php4.php5.inc.phtml.m.M.mm.py.f.for.f90.vhd.vhdl.tcl.ucf.qsf.md.markdownLanguageIDLIDLIDLJavaC#DPHPPHPPHPPHPPHPObjective-CObjective-CObjective-CPythonFortranFortranFortranVHDLVHDLTCLVHDLVHDLMarkdownMarkdownAny other extension is parsed as if it is a C/C++ file.If you start using doxygen for an existing project (thus without any documentation that doxygen is aware of), youcan still get an idea of what the structure is and how the documented result would look like.

To do so, you mustset the EXTRACT_ALL tag in the configuration file to YES. Then, doxygen will pretend everything in your sourcesis documented. Please note that as a consequence warnings about undocumented members will not be generatedas long as EXTRACT_ALL is set to YES.To analyze an existing piece of software it is useful to cross-reference a (documented) entity with its definition in thesource files. Doxygen will generate such cross-references if you set the SOURCE_BROWSER tag to YES. It canalso include the sources directly into the documentation by setting INLINE_SOURCES to YES (this can be handyfor code reviews for instance).2.3Step 2: Running doxygenTo generate the documentation you can now enter:doxygen <config-file>Depending on your settings doxygen will create html, rtf, latex, xml and/or man directories inside the outputdirectory.

As the names suggest these directories contain the generated documentation in HTML, RTF, LATEX, XMLand Unix-Man page format.The default output directory is the directory in which doxygen is started. The root directory to which the output iswritten can be changed using the OUTPUT_DIRECTORY. The format specific directory within the output directorycan be selected using the HTML_OUTPUT, RTF_OUTPUT, LATEX_OUTPUT, XML_OUTPUT, and MAN_OUTPUT tags of the configuration file. If the output directory does not exist, doxygen will try to create it for you (but itwill not try to create a whole path recursively, like mkdir -p does).Generated by Doxygen162.3.1Getting StartedHTML outputThe generated HTML documentation can be viewed by pointing a HTML browser to the index.html file in thehtml directory. For the best results a browser that supports cascading style sheets (CSS) should be used (I’musing Mozilla Firefox, Google Chrome, Safari, and sometimes IE8, IE9, and Opera to test the generated output).Some of the features the HTML section (such as GENERATE_TREEVIEW or the search engine) require a browserthat supports Dynamic HTML and Javascript enabled.2.3.2LaTeX outputThe generated LATEX documentation must first be compiled by a LATEX compiler (I use a recent teTeX distribution forLinux and MacOSX and MikTex for Windows).

To simplify the process of compiling the generated documentation,doxygen writes a Makefile into the latex directory (on the Windows platform also a make.bat batch file isgenerated).The contents and targets in the Makefile depend on the setting of USE_PDFLATEX. If it is disabled (set to NO),then typing make in the latex directory a dvi file called refman.dvi will be generated. This file can then beviewed using xdvi or converted into a PostScript file refman.ps by typing make ps (this requires dvips).To put 2 pages on one physical page use make ps_2on1 instead. The resulting PostScript file can be send to aPostScript printer.