diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 93 |
1 files changed, 69 insertions, 24 deletions
diff --git a/doc/config.doc b/doc/config.doc index 2bf3dc7..f238ad1 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -35,7 +35,7 @@ Values are sequences of non-blanks. If the value should contain one or more blanks it must be surrounded by quotes ("..."). Multiple lines can be concatenated by inserting a backslash (\\) as the last character of a line. -Environment variables can expanded using the pattern \$(ENV_VARIABLE_NAME). +Environment variables can expanded using the pattern \c $(ENV_VARIABLE_NAME). The configuration options can be divided into several categories. Below is a list of tags that are recognized for each category. @@ -155,7 +155,7 @@ Below is a list of tags that are recognized for each category. \addindex STRIP_FROM_PATH If the \c FULL_PATH_NAMES tag is set to \c YES then the \c STRIP_FROM_PATH tag can be used to strip a user defined part of the path. Stripping is - only done if the specified string matches the left-hand part of the + only done if one of the specified strings matches the left-hand part of the path. <dt>\c CLASS_DIAGRAMS <dd> @@ -164,6 +164,12 @@ Below is a list of tags that are recognized for each category. generate a class diagram (in Html and LaTeX) for classes with base or super classes. Setting the tag to \c NO turns the diagrams off. +<dt>\c SOURCE_BROWSER <dd> + \addindex SOURCE_BROWSER + If the \c SOURCE_BROWSER tag is set to \c YES than the body of a member or + function will be appended as a block of code to the documentation of. + that member or function. + <dt>\c CASE_SENSE_NAMES <dd> \addindex CASE_SENSE_NAMES If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then Doxygen @@ -179,6 +185,13 @@ Below is a list of tags that are recognized for each category. which an include is specified. Set to NO to disable this.\n"; \sa Section \ref cmdclass "\\class". +<dt>\c JAVADOC_AUTOBRIEF <dd> + \addinex JAVADOC_AUTOBRIEF + If the JAVADOC_NO_AUTOBRIEF is set to YES (the default) then Doxygen + will interpret the first line (until the first dot) of a JavaDoc-style + comment as the brief description. If set to NO, the Javadoc-style will + behave just like the Qt-style comments. + </dl> \subsection config_input Input related options @@ -226,12 +239,6 @@ Below is a list of tags that are recognized for each category. directories that contain example code fragments that are included (see the \\include command in section \ref cmdinclude "\\include"). -<dt>\c INCLUDE_PATH <dd> - \addindex INCLUDE_PATH - The INCLUDE_PATH tag can be used to specify one or more directories that - contain include files that are not input files but should be processed by - the preprocessor. - <dt>\c INPUT_FILTER <dd> \addindex INPUT_FILTER The \c INPUT_FILTER tag can be used to specify a program that doxygen should @@ -298,6 +305,44 @@ Below is a list of tags that are recognized for each category. Doxygen will replace them by respectively the title of the page, the current date and time, or only the current date. +<dt>\c HTML_ALIGN_MEMBERS <dd> + +If the \c HTML_ALIGN_MEMBERS tag is set to \c YES, the members of classes, +files or namespaces will be aligned in HTML using tables. If set to +NO a bullet list will be used. + +\par Notice +Setting this tag to NO will become obsolete in the future, since I only +intent to support and test the aligned representation. + +<dt>\c GENERATE_HTMLHELP <dd> + +If the \c GENERATE_HTMLHELP tag is set to \c YES, +doxygen generates three additional HTML index files: +\c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a +project file that can be read by +<a href="http://msdn.microsoft.com/workshop/author/htmlhelp"> +Microsoft HTML help workshop</a> +\latexonly +(see http://msdn.microsoft.com/workshop/author/htmlhelp) +\endlatexonly +on Windows. + +The HTML workshop contains a compiler that can convert all HTML output +generated by doxygen into a single compressed HTML file (.chm). Compressed +HTML files are now used as the Windows 98 help format, and will replace +the old windows help format (.hlp) on all Windows platforms in the future. +Compressed HTML files also contain an index, a table of contents, +and you can search for words in the documentation +(which basically renders \c doxysearch obsolete on Windows). +The HTML workshop also contains a viewer for compressed HTML files. + +<dt>\c ALPHABETICAL_INDEX <dd> + +If the \c ALPHABETICAL_INDEX tag is set to \c YES, an alphabetical index +of all compounds will be generated. Enable this if the project contains +a lot of classes, structs, unions or interfaces. + </dl> \subsection latex_output LaTeX related options @@ -542,22 +587,22 @@ SEARCH_INCLUDES = YES FULL_PATH_NAMES = YES STRIP_FROM_PATH = $(QTDIR)/ PREDEFINED = USE_TEMPLATECLASS Q_EXPORT= \ - QArrayT=QArray \ - QListT=QList \ - QDictT=QDict \ - QQueueT=QQueue \ - QVectorT=QVector \ - QPtrDictT=QPtrDict \ - QIntDictT=QIntDict \ - QStackT=QStack \ - QDictIteratorT=QDictIterator \ - QListIteratorT=QListIterator \ - QCacheT=QCache \ - QCacheIteratorT=QCacheIterator \ - QIntCacheT=QIntCache \ - QIntCacheIteratorT=QIntCacheIterator \ - QIntDictIteratorT=QIntDictIterator \ - QPtrDictIteratorT=QPtrDictIterator + QArrayT:=QArray \ + QListT:=QList \ + QDictT:=QDict \ + QQueueT:=QQueue \ + QVectorT:=QVector \ + QPtrDictT:=QPtrDict \ + QIntDictT:=QIntDict \ + QStackT:=QStack \ + QDictIteratorT:=QDictIterator \ + QListIteratorT:=QListIterator \ + QCacheT:=QCache \ + QCacheIteratorT:=QCacheIterator \ + QIntCacheT:=QIntCache \ + QIntCacheIteratorT:=QIntCacheIterator \ + QIntDictIteratorT:=QIntDictIterator \ + QPtrDictIteratorT:=QPtrDictIterator INPUT = $(QTDIR)/doc \ $(QTDIR)/src/widgets \ $(QTDIR)/src/kernel \ |