Skip to content Skip to sidebar Skip to footer
Home / Can I Upload a Doxygen Html File

Can I Upload a Doxygen Html File

Post a Comment

Getting started

The executable doxygen is the principal program that parses the sources and generates the documentation. See department Doxygen usage for more detailed usage information.

The executable doxytag is only needed if you want to generate references to external documentation (i.e. documentation that was generated by doxygen) for which you do not have the sources. See department Doxytag usage for more than detailed usage information.

Optionally, the executable doxywizard tin can be used, which is a graphical front-end for editing the configuration file that is used by doxygen.

The post-obit figure shows the relation between the tools and the flow of information betwixt them:

infoflow.gif

Doxygen information menstruum

Step 1: Creating a configuration file

Doxygen uses a configuration file to determine all of its settings. Each project should become its ain configuration file. A project can consist of a single source file, simply can too be an unabridged source tree that is recursively scanned.

To simplify the cosmos of a configuration file, doxygen tin can create a template configuration file for yous. To do this telephone call doxygen from the control line with the -m option:

where <config-file> is the name of the configuration file. If y'all omit the file proper name, a file named Doxyfile will be created. If a file with the name <config-file> already exists, doxygen will rename it to <config-file>.bak before generating the configuration template. If you use - (i.e. the minus sign) as the file name then doxygen will try to read the configuration file from standard input (stdin).

The configuration file has a format that is similar to that of a (uncomplicated) Makefile. It contains of a number of assignments (tags) of the form:

TAGNAME = VALUE or
TAGNAME = VALUE1 VALUE2 ...

You can probably get out the values of almost tags in a generated template configuration file to their default value. Encounter department Configuration for more details nigh the configuration file.

If you do not wish to edit the config file with a text editor, you should take a look at doxywizard, which is a GUI front-stop that can create, read and write doxygen configuration files, and allows setting configuration options past inbound them via dialogs.

For a small project consisting of a few C and/or C++ source and header files, you lot can get out INPUT tag empty and doxygen will search for sources in the electric current directory.

If you lot have a larger project consisting of a source directory or tree yous should put the root directory or directories subsequently the INPUT tag, and add 1 or more file patterns to the FILE_PATTERNS tag (for instance *.cpp *.h). Only files that friction match one of the patterns will be parsed (if the patterns are omitted a listing of source extensions is used). For recursive parsing of a source tree you must set the RECURSIVE tag to YES. To further fine-tune the listing of files that is parsed the EXCLUDE and EXCLUDE_PATTERNS tags can exist used. To omit all test directories from a source tree for instance, 1 could apply: 

          EXCLUDE_PATTERNS = */examination/*

Doxygen commonly parses files if they are C or C++ sources. If a file has a .idl or .odl extension information technology is treated as an IDL file. If information technology has a .java extension it is treated every bit a file written in Java. Files ending with .cs are treated as C# files. Finally, files with the extensions .php, .php4, .inc or .phtml are treated equally PHP sources.

If you start using doxygen for an existing project (thus without whatsoever documentation that doxygen is aware of), y'all can even so go an idea of what the documented issue would be. To do so, yous must set the EXTRACT_ALL tag in the configuration file to YES. And so, doxygen will pretend everything in your sources is documented. Please note that as a issue warnings about undocumented members will not be generated equally long as EXTRACT_ALL is set to YES.

To analyse an existing slice of software it is useful to cross-reference a (documented) entity with its definition in the source files. Doxygen will generate such cantankerous-references if you set the SOURCE_BROWSER tag to YES. It tin can also include the sources directly into the documentation by setting INLINE_SOURCES to Yeah (this tin can be handy for code reviews for instance).

Pace two: Running doxygen

To generate the documentation you lot can now enter:

Doxygen volition create a html, rtf, latex and/or human being directory inside the output directory. Equally the names advise these directories contain the generated documentation in HTML, RTF, $\mbox{\LaTeX}$ and Unix-Human page format.

The default output directory is the directory in which doxygen is started. The directory to which the output is written tin can be changed using the OUTPUT_DIRECTORY, HTML_OUTPUT, RTF_OUTPUT, LATEX_OUTPUT, and MAN_OUTPUT tags of the configuration file. If the output directory does non exist, doxygen volition endeavor to create it for you.

The generated HTML documentation can be viewed by pointing a HTML browser to the index.html file in the html directory. For the all-time results a browser that supports cascading style sheets (CSS) should exist used (I'grand currently using Netscape 4.61 to test the generated output).

The generated $\mbox{\LaTeX}$ documentation must outset exist compiled by a $\mbox{\LaTeX}$ compiler (I use teTeX distribution version 0.nine that contains $\mbox{\TeX}$ version iii.14159). To simplify the process of compiling the generated documentation, doxygen writes a Makefile into the latex directory. By typing brand in the latex directory the dvi file refman.dvi will be generated (provided that you lot have a make tool called make of class). This file can then exist viewed using xdvi or converted into a PostScript file refman.ps by typing make ps (this requires dvips). To put 2 pages on one physical folio use make ps_2on1 instead. The resulting PostScript file can be send to a PostScript printer. If you lot do not have a PostScript printer, you tin can attempt to use ghostscript to convert PostScript into something your printer understands. Conversion to PDF is also possible if you lot have installed the ghostscript interpreter; just type make pdf (or make pdf_2on1). To go the best results for PDF output you should set the PDF_HYPERLINKS tag to Yep.

The generated man pages can be viewed using the man program. You do need to make sure the man directory is in the man path (run across the MANPATH environment variable). Annotation that in that location are some limitations to the capabilities of the man page format, so some information (like class diagrams, cross references and formulas) will be lost.

Step 3: Documenting the sources

Although documenting the source is presented every bit pace 3, in a new project this should of course exist step 1. Here I assume you already have some lawmaking and you desire doxygen to generate a nice document describing the API and maybe the internals as well.

If the EXTRACT_ALL option is set to NO in the configuration file (the default), and then doxygen volition only generate documentation for documented members, files, classes and namespaces. So how exercise y'all certificate these? For members, classes and namespaces at that place are basically two options:

  1. Identify a special documentation block in front of the declaration or definition of the member, form or namespace. For file, form and namespace members it is likewise allowed to place the documention straight after the member. Encounter section Special documentation blocks to learn more near special documentation blocks.
  2. Place a special documentation block somewhere else (another file or another location) and put a structural command in the documentation cake. A structural control links a documentation block to a certain entity that can be documented (east.g. a member, course, namespace or file). See section Documentation at other places to learn more nearly structural commands.
Files can only be documented using the second choice, since there is no way to put a documentation cake earlier a file. Of course, file members (functions, variable, typedefs, defines) do not need an explicit structural command; just putting a special documentation block in front end or behind them will exercise.

The text inside a special documentation block is parsed before information technology is written to the HTML and/or $\mbox{\LaTeX}$ output files.

During parsing the post-obit steps have identify:

Go to the next section or return to the index.

Generated on Thu Feb 5 16:59:06 2004 for Doxygen manual by doxygen 1.3.v

mahoodsatond.blogspot.com

Source: https://www.star.bnl.gov/public/comp/sofi/doxygen/starting.html

Post a Comment for "Can I Upload a Doxygen Html File"