Doxygen will copy the logo to the output directory. The maximum height of the logo should not exceed 55 pixels and the maximum width should not exceed 200 pixels. With the PROJECT_LOGO tag one can specify a logo or an icon that is included in the documentation. Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. This could be handy for archiving the generated documentation or if some version control system is used. The PROJECT_NUMBER tag can be used to enter a project or revision number. This name is used in the title of most generated pages and in a few other places. The PROJECT_NAME tag is a single word (or a sequence of words surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the documentation is generated. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. The default is UTF-8 which is also the encoding used for all text before the first occurrence of this tag. This tag specifies the encoding used for all characters in the configuration file that follow. Below is an alphabetical index of the tags that are recognized followed by the descriptions of the tags grouped by category. The configuration options can be divided into several categories. Do this by putting a tag with these paths before the tag, e.g.: = my_config_dir You can also specify a list of directories that should be searched before looking in the current working directory. The include file is searched in the current working directory. You can also include part of a configuration file from another configuration file using a tag as follows: = config_file_name A small example: DOT_PATH = $(YOUR_DOT_PATH) Multiple lines can be concatenated by inserting a backslash ( \) as the last character of a line.Įnvironment variables can be expanded using the pattern $(ENV_VARIABLE_NAME). If the value should contain one or more blanks it must be surrounded by quotes ( "."). For tags that take a list as their argument, the += operator can be used instead of = to append new values to the list. If the same tag is assigned more than once, the last assignment overwrites any earlier assignment. Each statement consists of a TAG_NAME written in capitals, followed by the equal sign ( =) and one or more values. The file essentially consists of a list of assignment statements. Comments begin with the hash character ( #) and ends at the end of the line.
Comments beginning with two hash characters ( #) at the end of the configuration file are also kept and placed at the end of the file. Comments beginning with two hash characters ( #) at the beginning of the configuration file are also kept and placed at the beginning of the file. Comments beginning with two hash characters ( #) are kept when updating the configuration file and are placed in front of the TAG they are in front of.
Comments may be placed anywhere within the file (except within quotes). The statements in the file are case-sensitive. The file may contain tabs and newlines for formatting purposes. A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile, with the default name Doxyfile.
0 kommentar(er)
