diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2000-07-23 15:31:35 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2000-07-23 15:31:35 (GMT) |
commit | 422c14b6f19d70c78762ea571031f142acf9a972 (patch) | |
tree | 191fcbf13137ceda80267e217af7556d5a1f194e /doc | |
parent | 686cb8df0c558cdfe8b0b9a48355566391daf073 (diff) | |
download | Doxygen-422c14b6f19d70c78762ea571031f142acf9a972.zip Doxygen-422c14b6f19d70c78762ea571031f142acf9a972.tar.gz Doxygen-422c14b6f19d70c78762ea571031f142acf9a972.tar.bz2 |
Release-1.2.0
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Doxyfile | 8 | ||||
-rw-r--r-- | doc/commands.doc | 148 | ||||
-rw-r--r-- | doc/config.doc | 190 | ||||
-rw-r--r-- | doc/doxygen_usage.doc | 55 | ||||
-rw-r--r-- | doc/doxywizard.gif | bin | 0 -> 18928 bytes | |||
-rw-r--r-- | doc/doxywizard_usage.doc | 50 | ||||
-rw-r--r-- | doc/history.doc | 2 | ||||
-rw-r--r-- | doc/index.doc | 3 | ||||
-rw-r--r-- | doc/install.doc | 52 | ||||
-rw-r--r-- | doc/starting.doc | 15 | ||||
-rw-r--r-- | doc/trouble.doc | 20 |
11 files changed, 359 insertions, 184 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index 2c5c5e4..9c299b1 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -14,8 +14,8 @@ PROJECT_NAME = OUTPUT_DIRECTORY = .. -HTML_HEADER = -HTML_FOOTER = +HTML_HEADER = +HTML_FOOTER = QUIET = NO WARNINGS = YES DISABLE_INDEX = YES @@ -26,11 +26,15 @@ GENERATE_LATEX = YES GENERATE_HTML = YES GENERATE_HTMLHELP = YES GENERATE_RTF = NO +ENABLED_SECTIONS = logo_on ENABLE_PREPROCESSING = NO +CASE_SENSE_NAMES = NO +IMAGE_PATH = . INPUT = index.doc install.doc starting.doc docblocks.doc \ grouping.doc formulas.doc diagrams.doc preprocessing.doc \ external.doc faq.doc trouble.doc history.doc features.doc \ doxygen_usage.doc doxytag_usage.doc doxysearch_usage.doc \ + doxywizard_usage.doc \ installdox_usage.doc output.doc autolink.doc \ config.doc commands.doc htmlcmds.doc language.doc FILE_PATTERNS = *.cpp *.h *.doc diff --git a/doc/commands.doc b/doc/commands.doc index 5617c5b..7791c8b 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -61,6 +61,7 @@ documentation: <li> \refitem cmddeprecated \deprecated <li> \refitem cmddontinclude \dontinclude <li> \refitem cmde \e +<li> \refitem cmdem \em <li> \refitem cmdendcode \endcode <li> \refitem cmdendhtmlonly \endhtmlonly <li> \refitem cmdendif \endif @@ -84,13 +85,16 @@ documentation: <li> \refitem cmdinternal \internal <li> \refitem cmdinvariant \invariant <li> \refitem cmdlatexonly \latexonly +<li> \refitem cmdli \li <li> \refitem cmdline \line <li> \refitem cmdlink \link <li> \refitem cmdmainpage \mainpage <li> \refitem cmdname \name <li> \refitem cmdnamespace \namespace <li> \refitem cmdnosubgrouping \nosubgrouping +<li> \refitem cmdnote \note <li> \refitem cmdoverload \overload +<li> \refitem cmdp \p <li> \refitem cmdpage \page <li> \refitem cmdpar \par <li> \refitem cmdparam \param @@ -165,17 +169,6 @@ Doxygen. Unrecognized commands are treated as normal text. \endhtmlonly <hr> -\subsection cmdcode \code - - \addindex \code - Starts a block of code. A code block is treated differently - from ordinary text. It is interpreted as C/C++ code. The names of the - classes and members that are documented are automatically replaced by - links to the documentation. - - \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim" - -<hr> \subsection cmddef \def <name> \addindex \def @@ -185,7 +178,7 @@ Doxygen. Unrecognized commands are treated as normal text. \par Example: \verbinclude define.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/index.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define.h.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -204,13 +197,6 @@ Doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdingroup "\\ingroup" <hr> -\subsection cmdendcode \endcode - - \addindex \endcode - Ends a block of code. - \sa section \ref cmdcode "\\code" - -<hr> \subsection cmdenum \enum <name> @@ -229,7 +215,7 @@ Doxygen. Unrecognized commands are treated as normal text. \par Example: \verbinclude enum.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/enum/html/index.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/enum/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -260,7 +246,7 @@ Doxygen. Unrecognized commands are treated as normal text. Where the example file \c example_test.cpp looks as follows: \verbinclude example_test.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/example/html/index.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/example/html/examples.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -283,7 +269,7 @@ Doxygen. Unrecognized commands are treated as normal text. \par Example: \verbinclude file.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/index.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file.h.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -412,6 +398,8 @@ Public/Protected/Private/... section. \par Note 1: You are responsible that there is indeed an earlier documented member that is overloaded by this one. + To prevent that document reorders the documentation you should set + \ref cfg_sort_member_docs "SORT_MEMBER_DOCS" to NO in this case. \par Note 2: The \\overload command does not work inside a one-line comment. \par Example: @@ -685,6 +673,20 @@ Public/Protected/Private/... section. sectioning command is encountered. <hr> +\subsection cmdnote \note { text } + + \addindex \note + Starts a paragraph where a note can be entered. The paragraph will be + indented. The text of the paragraph has no special internal structure. + All visual enhancement commands may be used inside the paragraph. + Multiple adjacent \\note commands will be joined into a single paragraph. + Each note description will start on a new line. + Alternatively, one \\note command may mention + several notes. The \\note command ends when a blank line or some other + sectioning command is encountered. See section \ref cmdpar "\\par" + for an example. + +<hr> \subsection cmdpar \par [(paragraph title)] { paragraph } \addindex \par @@ -797,10 +799,11 @@ Public/Protected/Private/... section. \addindex \sa Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. - The separators \c :: and \c # may be used to separate a class from the - name of its members. One of several overloaded methods or constructors + Two names joines by either <code>::</code> or <code>\#</code> + are understood as referring to a class and one of its members. + One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after - the method. + the method name. Synonymous to \\see. @@ -1112,11 +1115,11 @@ Public/Protected/Private/... section. \par Example: \verbatim - ... the \a x and \y coordinates are used to ... + ... the \a x and \a y coordinates are used to ... \endverbatim This will result in the following text:<br><br> ... the \a x and \a y coordinates are used to ... - + <hr> \subsection cmdarg \arg { item-description } @@ -1147,6 +1150,9 @@ Public/Protected/Private/... section. \par Note: For nested lists, HTML commands should be used. + Equivalent to \ref cmdli "\\cmdli" + + <hr> \subsection cmdb \b <word> @@ -1170,6 +1176,19 @@ Public/Protected/Private/... section. will result in the following text:<br><br> ... This function returns \c void and not \c int ... + Equivalent to \ref cmdp "\\cmdp" + +<hr> +\subsection cmdcode \code + + \addindex \code + Starts a block of code. A code block is treated differently + from ordinary text. It is interpreted as C/C++ code. The names of the + classes and members that are documented are automatically replaced by + links to the documentation. + + \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim" + <hr> \subsection cmde \e <word> @@ -1185,6 +1204,32 @@ Public/Protected/Private/... section. will result in the following text:<br><br> ... this is a \e really good example ... + Equvalent to \ref cmdem "\\em" + +<hr> +\subsection cmdem \em <word> + + \addindex \e + Displays the argument \<word\> in italics. + Use this command to emphasize words. + + \par Example: + Typing: + \verbatim + ... this is a \em really good example ... + \endverbatim + will result in the following text:<br><br> + ... this is a \em really good example ... + + Equivalent to \ref cmde "\\e" + +<hr> +\subsection cmdendcode \endcode + + \addindex \endcode + Ends a block of code. + \sa section \ref cmdcode "\\code" + <hr> \subsection cmdendhtmlonly \endhtmlonly @@ -1322,6 +1367,55 @@ Public/Protected/Private/... section. and section \ref cmdhtmlonly "\\htmlonly". <hr> +\subsection cmdli \li { item-description } + + \addindex \li + This command has one argument that continues until the first + blank line or until another \\li is encountered. + The command can be used to generate a simple, not nested list of + arguments. + Each argument should start with a \\li command. + + \par Example: + Typing: + \verbatim + \li \c AlignLeft left alignment. + \li \c AlignCenter center alignment. + \li \c AlignRight right alignment + + No other types of alignment are supported. + \endverbatim + will result in the following text:<br><br> + <ul> + <li> \c AlignLeft left alignment. + <li> \c AlignCenter center alignment. + <li> \c AlignRight right alignment + </ul><br> + No other types of alignment are supported. + + \par Note: + For nested lists, HTML commands should be used. + + Equivalent to \ref cmdarg "\\cmdarg" + +<hr> +\subsection cmdp \p <word> + + \addindex \p + Displays the parameter \<word\> using a typewriter font. + You can use this command to refer to member function parameters in + the running text. + + \par Example: + \verbatim + ... the \p x and \p y coordinates are used to ... + \endverbatim + This will result in the following text:<br><br> + ... the \p x and \p y coordinates are used to ... + + Equivalent to \ref cmdc "\\cmdc" + +<hr> \subsection cmdverbatim \verbatim \addindex \verbatim diff --git a/doc/config.doc b/doc/config.doc index fa9d86b..7581b99 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -21,8 +21,7 @@ \subsection config_format Format A configuration file is a free-form ASCII text file with a structure that -is similar to that of a Makefile. It is parsed by a -recursive-descent parser that is built into \c doxygen. +is similar to that of a Makefile. It is parsed by \c doxygen. The file may contain tabs and newlines for formatting purposes. The statements in the file are case-sensitive. Comments may be placed anywhere within the file (except within quotes). @@ -189,7 +188,7 @@ followed by the descriptions of the tags grouped by category. information to generate all constant output in the proper language. The default language is English, other supported languages are: Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, - Spanish, Russian, Croatian and Polish. + Spanish, Russian, Croatian, Polish and Portuguese. \anchor cfg_disable_index <dt>\c DISABLE_INDEX <dd> @@ -423,7 +422,8 @@ followed by the descriptions of the tags grouped by category. <dt>\c WARN_FORMAT <dd> \addindex WARN_FORMAT The WARN_FORMAT tag determines the format of the warning messages that - doxygen can produce. The string should contain the $file, $line, and $text + doxygen can produce. The string should contain the <code>\$file</code>, + <code>\$line</code>, and <code>\$text</code> tags, which will be replaced by the file and line number from which the warning originated and the warning text. @@ -559,7 +559,9 @@ followed by the descriptions of the tags grouped by category. \addindex HTML_HEADER The \c HTML_HEADER tag can be used to specify a user defined HTML header file for each generated HTML page. To get valid HTML the header file - should contain at least a \c <HTML> and a \c <BODY> tag. Example: + should contain at least a \c <HTML> and a \c <BODY> tag, but it is + good idea to include the style sheet that is generated by doxygen as well. + Minimal example: \verbatim <HTML> <HEAD> @@ -580,12 +582,15 @@ followed by the descriptions of the tags grouped by category. the version number of doxygen, the project name (see \c PROJECT_NAME), or the project number (see \c PROJECT_NUMBER). + See also section \ref doxygen_usage for information on how to generate + the default header that doxygen normally uses. + \anchor cfg_html_footer <dt>\c HTML_FOOTER <dd> \addindex HTML_FOOTER The \c HTML_FOOTER tag can be used to specify a user defined HTML footer for each generated HTML page. To get valid HTML the header file should contain - at least a \c </BODY> and a \c </HTML> tag. Example: + at least a \c </BODY> and a \c </HTML> tag. A minimal example: \verbatim </BODY> </HTML> @@ -600,7 +605,9 @@ followed by the descriptions of the tags grouped by category. the title of the page, the current date and time, only the current date, the version number of doxygen, the project name (see \c PROJECT_NAME), or the project number (see \c PROJECT_NUMBER). - + + See also section \ref doxygen_usage for information on how to generate + the default footer that doxygen normally uses. \anchor cfg_html_stylesheet <dt>\c HTML_STYLESHEET <dd> @@ -608,32 +615,10 @@ followed by the descriptions of the tags grouped by category. The \c HTML_STYLESHEET tag can be used to specify a user defined cascading style sheet that is used by each HTML page. It can be used to fine-tune the look of the HTML output. If the tag is left blank doxygen - will generate a default style sheet. Here is the default style sheet - that doxygen normally generates: + will generate a default style sheet. -\verbatim -H1 { text-align: center; } -A.qindex {} -A.qindexRef {} -A.el { text-decoration: none; font-weight: bold } -A.elRef { font-weight: bold } -A.code { text-decoration: none; font-weight: normal; color: #4444ee } -A.codeRef { font-weight: normal; color: #4444ee } -DL.el { margin-left: -1cm } -DIV.fragment { width: 100%; border: none; background-color: #eeeeee } -DIV.in { margin-left: 16 } -DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 } -TD.md { background-color: #f2f2ff } -DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight -DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller } -FONT.keyword { color: #008000 } -FONT.keywordtype { color: #604020 } -FONT.keywordflow { color: #e08000 } -FONT.comment { color: #800000 } -FONT.preprocessor { color: #806020 } -FONT.stringliteral { color: #002080 } -FONT.charliteral { color: #008080 } -\endverbatim + See also section \ref doxygen_usage for information on how to generate + the style sheet that doxygen normally uses. \anchor cfg_html_align_members <dt>\c HTML_ALIGN_MEMBERS <dd> @@ -724,32 +709,11 @@ EXTRA_PACKAGES = times \addindex LATEX_HEADER The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ header for the generated latex document. The header should contain everything - until the first chapter. If it is left blank doxygen will generate a - standard header, which looks as follows for the default - configuration settings: + until the first chapter. -\verbatim -\documentclass[a4paper]{book} -\usepackage{a4wide} -\usepackage{makeidx} -\usepackage{fancyheadings} -\usepackage{epsfig} -\usepackage{float} -\usepackage{doxygen} -\makeindex -\setcounter{tocdepth}{1} -\setlength{\footrulewidth}{0.4pt} -\begin{document} -\title{Reference Manual} -\author{Generated by Doxygen} -\date{Thu Sep 30 19:58:32 1999} -\maketitle -\pagenumbering{roman} -\clearemptydoublepage -\tableofcontents -\clearemptydoublepage -\pagenumbering{arabic} -\endverbatim + If it is left blank doxygen will generate a + standard header. See section \ref doxygen_usage for information on how to + let doxygen write the default header to a separate file. \par Note: Only use a user defined header if you know what you are doing! @@ -790,8 +754,7 @@ EXTRA_PACKAGES = times <dt>\c GENERATE_RTF <dd> \addindex GENERATE_RTF If the \c GENERATE_RTF tag is set to \c YES Doxygen will generate RTF output. - For now this is experimental and is disabled by default. The RTF - output is optimised for Word 97 and may not look too pretty with + The RTF output is optimised for Word 97 and may not look too pretty with other readers/editors. \anchor cfg_rtf_output @@ -820,89 +783,15 @@ EXTRA_PACKAGES = times \par note: wordpad (write) and others do not support links. -\anchor cfg_rtf_stylesheet_file RTF_STYLESHEET_FILE +\anchor cfg_rtf_stylesheet_file <dt>\c RTF_STYLESHEET_FILE <dd> \addindex RTF_STYLESHEET_FILE Load stylesheet definitions from file. Syntax is similar to doxygen's config file, i.e. a series of assigments. You only have to provide replacements, missing definitions are set to their default value. -\htmlonly -Here are the default settings: -<font size=2><pre>Reset = \\pard\\plain -Heading1 = \\s1\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\fs36\\kerning36\\cgrid -Heading2 = \\s2\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\fs28\\kerning28\\cgrid -Heading3 = \\s3\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\cgrid -Heading4 = \\s4\\sb240\\sa60\\keepn\\widctlpar\\adjustright \\b\\f1\\fs20\\cgrid -Title = \\s15\\qc\\sb240\\sa60\\widctlpar\\outlinelevel0\\adjustright \\b\\f1\\fs32\\kerning28\\cgrid -SubTitle = \\s16\\qc\\sa60\\widctlpar\\outlinelevel1\\adjustright \\f1\\cgrid -BodyText = \\s17\\sa60\\sb30\\widctlpar\\qj \\fs22\\cgrid -DenseText = \\s18\\widctlpar\\fs22\\cgrid -Header = \\s28\\widctlpar\\tqc\\tx4320\\tqr\\tx8640\\adjustright \\fs20\\cgrid -Footer = \\s29\\widctlpar\\tqc\\tx4320\\tqr\\tx8640\\qr\\adjustright \\fs20\\cgrid -GroupHeader = \\s30\\li360\\sa60\\sb120\\keepn\\widctlpar\\adjustright \\b\\f1\\fs20\\cgrid -CodeExample0 = \\s40\\li0\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample1 = \\s41\\li360\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample2 = \\s42\\li720\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample3 = \\s43\\li1080\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample4 = \\s44\\li1440\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample5 = \\s45\\li1800\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample6 = \\s46\\li2160\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample7 = \\s47\\li2520\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample8 = \\s48\\li2880\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -CodeExample9 = \\s49\\li3240\\widctlpar\\adjustright \\shading1000\\cbpat8 \\f2\\fs16\\cgrid -ListContinue0 = \\s50\\li0\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue1 = \\s51\\li360\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue2 = \\s52\\li720\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue3 = \\s53\\li1080\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue4 = \\s54\\li1440\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue5 = \\s55\\li1800\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue6 = \\s56\\li2160\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue7 = \\s57\\li2520\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue8 = \\s58\\li2880\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -ListContinue9 = \\s59\\li3240\\sa60\\sb30\\qj\\widctlpar\\qj\\adjustright \\fs20\\cgrid -DescContinue0 = \\s60\\li0\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue1 = \\s61\\li360\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue2 = \\s62\\li720\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue3 = \\s63\\li1080\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue4 = \\s64\\li1440\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue5 = \\s65\\li1800\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue6 = \\s66\\li2160\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue7 = \\s67\\li2520\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue8 = \\s68\\li2880\\widctlpar\\ql\\adjustright \\fs20\\cgrid -DescContinue9 = \\s69\\li3240\\widctlpar\\ql\\adjustright \\fs20\\cgrid -LatexTOC0 = \\s70\\li0\\sa30\\sb30\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC1 = \\s71\\li360\\sa27\\sb27\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC2 = \\s72\\li720\\sa24\\sb24\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC3 = \\s73\\li1080\\sa21\\sb21\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC4 = \\s74\\li1440\\sa18\\sb18\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC5 = \\s75\\li1800\\sa15\\sb15\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC6 = \\s76\\li2160\\sa12\\sb12\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC7 = \\s77\\li2520\\sa9\\sb9\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC8 = \\s78\\li2880\\sa6\\sb6\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -LatexTOC9 = \\s79\\li3240\\sa3\\sb3\\widctlpar\\tqr\\tldot\\tx8640\\adjustright \\fs20\\cgrid -ListBullet0 = \\s80\\fi-360\\li360\\widctlpar\\jclisttab\\tx360{\\*\\pn \\pnlvlbody\\ilvl0\\ls1\\pnrnot0\\pndec }\\ls1\\adjustright \\fs20\\cgrid -ListBullet1 = \\s81\\fi-360\\li720\\widctlpar\\jclisttab\\tx720{\\*\\pn \\pnlvlbody\\ilvl0\\ls2\\pnrnot0\\pndec }\\ls2\\adjustright \\fs20\\cgrid -ListBullet2 = \\s82\\fi-360\\li1080\\widctlpar\\jclisttab\\tx1080{\\*\\pn \\pnlvlbody\\ilvl0\\ls3\\pnrnot0\\pndec }\\ls3\\adjustright \\fs20\\cgrid -ListBullet3 = \\s83\\fi-360\\li1440\\widctlpar\\jclisttab\\tx1440{\\*\\pn \\pnlvlbody\\ilvl0\\ls4\\pnrnot0\\pndec }\\ls4\\adjustright \\fs20\\cgrid -ListBullet4 = \\s84\\fi-360\\li1800\\widctlpar\\jclisttab\\tx1800{\\*\\pn \\pnlvlbody\\ilvl0\\ls5\\pnrnot0\\pndec }\\ls5\\adjustright \\fs20\\cgrid -ListBullet5 = \\s85\\fi-360\\li2160\\widctlpar\\jclisttab\\tx2160{\\*\\pn \\pnlvlbody\\ilvl0\\ls6\\pnrnot0\\pndec }\\ls6\\adjustright \\fs20\\cgrid -ListBullet6 = \\s86\\fi-360\\li2520\\widctlpar\\jclisttab\\tx2520{\\*\\pn \\pnlvlbody\\ilvl0\\ls7\\pnrnot0\\pndec }\\ls7\\adjustright \\fs20\\cgrid -ListBullet7 = \\s87\\fi-360\\li2880\\widctlpar\\jclisttab\\tx2880{\\*\\pn \\pnlvlbody\\ilvl0\\ls8\\pnrnot0\\pndec }\\ls8\\adjustright \\fs20\\cgrid -ListBullet8 = \\s88\\fi-360\\li3240\\widctlpar\\jclisttab\\tx3240{\\*\\pn \\pnlvlbody\\ilvl0\\ls9\\pnrnot0\\pndec }\\ls9\\adjustright \\fs20\\cgrid -ListBullet9 = \\s89\\fi-360\\li3600\\widctlpar\\jclisttab\\tx3600{\\*\\pn \\pnlvlbody\\ilvl0\\ls10\\pnrnot0\\pndec }\\ls10\\adjustright \\fs20\\cgrid -ListEnum0 = \\s90\\fi-360\\li360\\widctlpar\\fs20\\cgrid -ListEnum1 = \\s91\\fi-360\\li720\\widctlpar\\fs20\\cgrid -ListEnum2 = \\s92\\fi-360\\li1080\\widctlpar\\fs20\\cgrid -ListEnum3 = \\s93\\fi-360\\li1440\\widctlpar\\fs20\\cgrid -ListEnum4 = \\s94\\fi-360\\li1800\\widctlpar\\fs20\\cgrid -ListEnum4 = \\s95\\fi-360\\li2160\\widctlpar\\fs20\\cgrid -ListEnum5 = \\s96\\fi-360\\li2520\\widctlpar\\fs20\\cgrid -ListEnum6 = \\s97\\fi-360\\li2880\\widctlpar\\fs20\\cgrid -ListEnum7 = \\s98\\fi-360\\li3240\\widctlpar\\fs20\\cgrid -ListEnum8 = \\s99\\fi-360\\li3600\\widctlpar\\fs20\\cgrid -</pre></font> -\endhtmlonly + See also section \ref doxygen_usage for information on how to generate + the default style sheet that doxygen normally uses. </dl> @@ -1247,6 +1136,35 @@ INCLUDE_PATH = $(QTDIR)/include RECURSIVE = YES \endverbatim +For the Qt-2.1 sources I recommand to use the following settings: +\verbatim +PROJECT_NAME = Qt +PROJECT_NUMBER = 2.1 +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +SOURCE_BROWSER = YES +INPUT = $(QTDIR)/src +FILE_PATTERNS = *.cpp *.h q*.doc +RECURSIVE = YES +EXCLUDE_PATTERNS = *codec.cpp moc_* */compat/* */3rdparty/* +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 3 +IGNORE_PREFIX = Q +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +INCLUDE_PATH = $(QTDIR)/include +PREDEFINED = Q_PROPERTY(x)= \ + Q_OVERRIDE(x)= \ + Q_EXPORT= \ + Q_ENUMS(x)= \ + "QT_STATIC_CONST=static const " \ + _WS_X11_ \ + INCLUDE_MENUITEM_DEF +EXPAND_ONLY_PREDEF = YES +EXPAND_AS_DEFINED = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \ + Q_VARIANT_AS +\endverbatim + Here Doxygen's preprocessor is used to substitute some macro names that are normally substituted by the C preprocessor, but without doing full macro expansion. diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index f781000..d8f4d2f 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -17,16 +17,17 @@ /*! \page doxygen_usage Doxygen usage Doxygen is a command line based utility. Calling \c doxygen with the -\c -h option at the command line will give you a brief description of the +\c --help option at the command line will give you a brief description of the usage of the program. All options consist of a leading character <tt>-</tt>, -followed by one character and optionally an argument. +followed by one character and one or more arguments depending on the option. -To generate a class browser you typically need to follow these steps: +To generate a manual for your project you typically +need to follow these steps: <ol> <li> You document your source code with - special documentation blocks. + special documentation blocks (see section \ref specialblock). <li> You generate a configuration file (see section \ref config) by calling doxygen with the \c -g option: \verbatim @@ -42,12 +43,50 @@ doxygen <config_file> \endverbatim </ol> +If you have a configuration file generated with an older version of +doxygen that you can upgrade it to the current version by running doxygen +with the -u option. +\verbatim +doxygen -u <config_file> +\endverbatim +All configuration settings in the orginal configuration file will be copied +to the new configuration file. Any new options will have their default value. +Note that comments that you may have added in the original configuration file +will be lost. + +If you want to fine-tune the way the output looks, doxygen allows you +generate default style sheet, header, and footer files that you can edit +afterwards: +<ul> +<li>For HTML output, you can generate the default header file + (see \ref cfg_html_header "HTML_HEADER"), the default footer + (see \ref cfg_html_footer "HTML_FOOTER"), and the default style + sheet (see \ref cfg_html_stylesheet "HTML_STYLESHEET"), using the + following command: +\verbatim +doxygen -w html header.html footer.html stylesheet.css +\endverbatim +<li>For LaTeX output, you can generate the first part of \c refman.tex + (see \ref cfg_latex_header "LATEX_HEADER") and the style sheet included + by that header (normally <code>doxygen.sty</code>), using: +\verbatim +doxygen -w latex header.tex doxygen.sty +\endverbatim +<li>For RTF output, you can generate the default style sheet file (see + \ref cfg_rtf_stylesheet_file "RTF_STYLESHEET_FILE") using: +\verbatim +doxygen -w rtf rtfstyle.cfg +\endverbatim +</ul> + <b>Note:</b><br> <ul> -<li> If you do not want the description for each item in the configuration - file then you can use the optional \c -s option. - Try to use this option if you send me a configuration file as part of - a bug report! +<li> If you do not want documentation for each item inside the configuration + file then you can use the optional \c -s option. This can use be + used in combination with the \c -u option, to add or strip the + documentation from an existing configuration file. + Please use the \c -s this option if you send me a configuration file + as part of a bug report! <li> To make doxygen read/write to standard input/output instead of from/to a file, use \c - for the file name. </ul> diff --git a/doc/doxywizard.gif b/doc/doxywizard.gif Binary files differnew file mode 100644 index 0000000..80bb636 --- /dev/null +++ b/doc/doxywizard.gif diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc new file mode 100644 index 0000000..59c7227 --- /dev/null +++ b/doc/doxywizard_usage.doc @@ -0,0 +1,50 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2000 by Dimitri van Heesch. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ +/*! \page doxywizard_usage Doxywizard usage + +Doxywizard is a GUI front-end for creating and editing +configuration files that are used by doxygen. + +Doxywizard consists of a single executable that, when started, +pops up a window. + +The main window has a number of tab field, one +for each section in the configuration file. Each tab-field +contains a number of lines, one for each configuration option in +that section. + +The kind of input widget depends on the type of the configuration option. +<ul> +<li>For each boolean option (those options that are answered with YES or + NO in the configuration file) there is a check-box. +<li>For items taking one of a fixed set of values (like + \ref cfg_output_language "OUTPUT_LANGUAGE") a combo box is used. +<li>For items taking an integer value from a range, a spinbox is used. +<li>For free form string-type options there is a one line edit field +<li>For options taking a lists of strings, a one line edit field is + available, with a `+' button to add this string to the list and + a `-' button to remove the selected string from the list. There + is also a button with a circular "refresh" arrow that, when pressed, + replaces the selected item in the list with the string entered in the + edit field. +<li>For file and folder entries, there are special buttons + that start a file dialog. +</ul> + +\image html doxywizard.gif + +*/ diff --git a/doc/history.doc b/doc/history.doc index aaa7e21..beee457 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -38,7 +38,7 @@ parser and GUI front-end from source templates. <li>Better support for the using keyword. <li>New transparent mini logo that is put in the footer of all HTML pages. -<li>Internationalization support for the Polish and Croatian language. +<li>Internationalization support for the Polish, Portuguese and Croatian language. <li>Todo list support. <li>If the source browser is enabled, for a function, a list of function whose implementation calls that function, is generated. diff --git a/doc/index.doc b/doc/index.doc index 6256799..198bf46 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -15,6 +15,7 @@ * */ /*! \page index +\if logo_on <center> \htmlonly <img align=center lowsrc="doxygen_logo_low.gif" src="doxygen_logo.gif" @@ -22,6 +23,7 @@ Version: $(VERSION) \endhtmlonly </center> +\endif <h2>Doxygen license</h2> \addindex license @@ -105,6 +107,7 @@ The second part forms a reference manual: <li>Section \ref doxygen_usage shows how to use the \c doxygen program. <li>Section \ref doxytag_usage shows how to use the \c doxytag program. <li>Section \ref doxysearch_usage shows how to use the \c doxysearch program. +<li>Section \ref doxywizard_usage shows how to use the \c doxywizard program. <li>Section \ref installdox_usage shows how to use the \c installdox script that is generated by Doxygen if you use tag files. <li>Section \ref output shows how to generate the various output formats diff --git a/doc/install.doc b/doc/install.doc index c03a529..2d31184 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -92,7 +92,11 @@ Compilation is now done by performing the following steps: If you have Qt-2.1.x installed and want to build the GUI front-end, you should run the configure script with the <code>--with-doxywizard</code> - option. + option: + +\verbatim + configure --with-doxywizard +\endverbatim For an overview of other configuration options use @@ -216,6 +220,9 @@ If you are compiling for HP-UX with aCC and you get this error: #include <alloca.h> \endverbatim + If that does not help, try removing <code>ce_parse.cpp</code> and let + bison rebuilt it (this worked for me). + If you are compiling for Digital Unix, the same problem can be solved (according to Barnard Schmallhof) by replacing the following in ce_parse.cpp: @@ -256,7 +263,50 @@ ce_parse.cpp: <b>Sun compiler problems</b> +I tried compiling doxygen only with Sun's C++ WorkShop Compiler +version 5.0 (I used <code>./configure --platform solaris-cc</code>) + +Qt-2.x.x is required for this compiler (Qt-1.44 has problems with the bool +type). + +Compiling the \c doxygen binary went ok, but while linking <code>doxytag</code> I got a +lot of link errors, like these: + +\verbatim +QList<PageInfo>::__vtbl /home/dimitri/doxygen/objects/SunWS_cache/CC_obj_6/6c3eO4IogMT2vrlGCQUQ.o +[Hint: try checking whether the first non-inlined, non-pure virtual function of class QList<PageInfo> is defined] +\endverbatim + +These are generated because the compiler is confused about the object sharing +between \c doxygen and \c doxytag. To compile \c doxytag and \c doxysearch +anyway do: +\verbatim +rm -rf objects +mkdir objects +cd src +gmake -f Makefile.doxytag +gmake -f Makefile.doxysearch +\endverbatim + +when configuring with <code>--static</code> I got: + +\verbatim +Undefined first referenced + symbol in file +dlclose /usr/lib/libc.a(nss_deffinder.o) +dlsym /usr/lib/libc.a(nss_deffinder.o) +dlopen /usr/lib/libc.a(nss_deffinder.o) +\endverbatim + +Manually adding <code>-Bdynamic</code> after the target rule in +<code>Makefile.doxygen</code> and <code>Makefile.doxytag</code> +will fix this: + +\verbatim +$(TARGET): $(OBJECTS) $(OBJMOC) + $(LINK) $(LFLAGS) -o $(TARGET) $(OBJECTS) $(OBJMOC) $(LIBS) -Bdynamic +\endverbatim <b>GNU 2.7.2.x compiler problems</b> diff --git a/doc/starting.doc b/doc/starting.doc index 332d1d2..23c6268 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -29,6 +29,9 @@ information. The executable \c doxysearch is only needed if you want to use the search engine. See section \ref doxysearch_usage for more detailed usage information. +Optionally, the executable \c doxywizard is a GUI front-end for editing +the configuration files that are used by doxygen. + \subsection step1 Step 1: Creating a configuration file Doxygen uses a configuration file to determine all of its settings. @@ -129,14 +132,16 @@ documentation, \c doxygen writes a \c Makefile into the \c latex directory. By typing \c make in the \c latex directory the dvi file \c refman.dvi will be generated (provided that you have a make tool called <code>make</code> ofcourse). This file can then be viewed using \c xdvi or -converted into a postscript file \c refman.ps by typing <code>make ps</code> -(this requires <code>dvips</code>). The Postscript file can be send to a postscript +converted into a postscript file \c refman.ps by +typing <code>make ps</code> (this requires <code>dvips</code>). +To put 2 pages on one physical page use <code>make ps_2on1</code> instead. +The resulting Postscript file can be send to a postscript printer. If you do not have a postscript printer, you can try to use ghostscript to convert postscript into something your printer understands. Conversion to PDF is also possible if you have installed the ghostscript -interpreter; just type <code>make pdf</code>. To get the best results for -PDF output you should set the \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" -tag to \c YES. +interpreter; just type <code>make pdf</code> (or <code>make pdf_2on1</code>). +To get the best results for PDF output you should set +the \ref cfg_pdf_hyperlinks "PDF_HYPERLINKS" tag to \c YES. The generated man pages can be viewed using the \c man program. You do need to make sure the man directory is in the man path (see the \c MANPATH diff --git a/doc/trouble.doc b/doc/trouble.doc index 3fac65e..1f309bc 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -80,12 +80,24 @@ know why. Furthermore, I would appreciate a mail if you have found a bug, or if you have ideas (or even better some code or a patch) -how to fix existing bugs and limitations. +how to fix existing bugs and limitations. For patches please use +"diff -u" + +<h2>How to report a bug</h2> + +If you think you have found a bug in doxygen, please report it so I can +fix it. + +Always include the following information in your bug report: +- The version of doxygen you are using. +- The name and version number of your operating system The easiest way for me to solve bugs is if you can send me a small example -demonstrating the problem you have (make sure the example compiles!). It is -usually a good idea to send along the configuation file as well, but please -use doxygen with the <code>-s</code> flag while generating it. +demonstrating the problem you have. Please make sure the example is valid +source code (try compiling it) and if the problem is really captured by +the example. +It is usually a good idea to send along the configuation file as well, +but please use doxygen with the <code>-s</code> flag while generating it. My e-mail address: <a href="mailto:dimitri@stack.nl">dimitri@stack.nl</a> */ |