diff options
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/config.xml b/src/config.xml index c3693ee..47c9148 100644 --- a/src/config.xml +++ b/src/config.xml @@ -152,7 +152,7 @@ are normally passed to the compiler using the -I flag. </option> <option type='bool' id='SHORT_NAMES' docs=' If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -(but less readable) file names. This can be useful is your file systems +(but less readable) file names. This can be useful if your file system doesn't support long names like on DOS, Mac, or CD-ROM. ' defval='0'/> <option type='bool' id='JAVADOC_AUTOBRIEF' docs=' @@ -238,7 +238,7 @@ If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to include (a tag file for) the STL sources as input, then you should set this tag to YES in order to let doxygen match functions declarations and definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -func(std::string) {}). This also make the inheritance and collaboration +func(std::string) {}). This also makes the inheritance and collaboration diagrams that involve STL classes more complete and accurate. ' defval='0'/> <option type='bool' id='CPP_CLI_SUPPORT' docs=' @@ -253,7 +253,7 @@ instead of private inheritance when no explicit protection keyword is present. <option type='bool' id='IDL_PROPERTY_SUPPORT' docs=' For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) -will make doxygen to replace the get and set methods by a property in the +will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO. @@ -327,7 +327,7 @@ If this flag is set to YES, the members of anonymous namespaces will be extracted and appear in the documentation as a namespace called 'anonymous_namespace{file}', where file will be replaced with the base name of the file that contains the anonymous namespace. By default -anonymous namespace are hidden. +anonymous namespaces are hidden. ' defval='0'/> <option type='bool' id='HIDE_UNDOC_MEMBERS' docs=' If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all @@ -447,10 +447,10 @@ documentation sections, marked by \if sectionname ... \endif. </option> <option type='int' id='MAX_INITIALIZER_LINES' docs=' The MAX_INITIALIZER_LINES tag determines the maximum number of lines -the initial value of a variable or define consists of for it to appear in +the initial value of a variable or macro consists of for it to appear in the documentation. If the initializer consists of more lines than specified here it will be hidden. Use a value of 0 to hide initializers completely. -The appearance of the initializer of individual variables and defines in the +The appearance of the initializer of individual variables and macros in the documentation can be controlled using \showinitializer or \hideinitializer command in the documentation regardless of this setting. ' minval='0' maxval='10000' defval='30'/> @@ -514,7 +514,7 @@ parameters in a documented function, or documenting parameters that don't exist or using markup commands wrongly. ' defval='1'/> <option type='bool' id='WARN_NO_PARAMDOC' docs=' -This WARN_NO_PARAMDOC option can be abled to get warnings for +The WARN_NO_PARAMDOC option can be abled to get warnings for functions that are documented, but have no documentation for their parameters or return value. If set to NO (the default) doxygen will only warn about wrong or incomplete parameter documentation, but not about the absence of @@ -1402,7 +1402,7 @@ graphs for selected functions only using the \callergraph command. ' defval='0' depends='HAVE_DOT'/> <option type='bool' id='GRAPHICAL_HIERARCHY' docs=' If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -will graphical hierarchy of all classes instead of a textual one. +will generate a graphical hierarchy of all classes instead of a textual one. ' defval='1' depends='HAVE_DOT'/> <option type='bool' id='DIRECTORY_GRAPH' docs=' If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES @@ -1412,7 +1412,7 @@ relations between the files in the directories. ' defval='1' depends='HAVE_DOT'/> <option type='enum' id='DOT_IMAGE_FORMAT' defval='png' docs=' The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -generated by dot. Possible values are png, jpg, or gif +generated by dot. Possible values are png, jpg, or gif. If left blank png will be used. ' depends='HAVE_DOT'> <value name='png'/> |