![]() 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. For a personal project do what you want (you should still document) but in a company/oss project this is vital.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. I am of the opinion that self explanatory code is the best type of documentation, but is not enough alone. But when it doesn't you will be screaming, wishing you had kept everything regularly updated. Yeah your project doesn't really need to be updated, and if it works it works. Problem is most people just code and code and code and then accumulate a LOT of debt because things like this "are not that important" until they bite you in the ass. If the burden of documenting, making tests, etc is spread in a task by task way, you don't have to "redo half of the work every year". The solution to having to revisit and rewrite lots of documentation every once in a while is just including it on the DoD and make it part of everyday development. Any production grade project with more than 1 dev (and even with just 1) should have written documentation (better if its on a docs-as-code solution) It's ridiculous to say well structured code doesn't need documentation.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |