diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2001-04-08 19:19:32 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2001-04-08 19:19:32 (GMT) |
commit | 8f195c2d389edeeaf0f76de36c5b5db788b6e312 (patch) | |
tree | 120d3069adfaa3da505045185569c8c67554d055 /doc | |
parent | c47269c4f1fb1387d6876075f3b2e935354d5b76 (diff) | |
download | Doxygen-8f195c2d389edeeaf0f76de36c5b5db788b6e312.zip Doxygen-8f195c2d389edeeaf0f76de36c5b5db788b6e312.tar.gz Doxygen-8f195c2d389edeeaf0f76de36c5b5db788b6e312.tar.bz2 |
Doxygen-1.2.6-20010408
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 10 | ||||
-rw-r--r-- | doc/doxysearch_usage.doc | 2 | ||||
-rw-r--r-- | doc/faq.doc | 4 | ||||
-rw-r--r-- | doc/starting.doc | 10 |
4 files changed, 13 insertions, 13 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index c6aa049..e34d5c5 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -191,7 +191,7 @@ Doxygen. Unrecognized commands are treated as normal text. Indicates that a comment block contains documentation for a \ref modules "group" of classes, files or namespaces. This can be used to categorize classes, files or namespaces, and document those - categories. You can also uses groups as members of other groups, + categories. You can also use groups as members of other groups, thus building a hierarchy of groups. The \<name\> argument should an single word identifier. @@ -639,7 +639,7 @@ Public/Protected/Private/... section. \addindex \if Starts a conditional documentation section. The section ends with a matching \c \endif command. A conditional section is - disable by default. To enable it you must put the + disabled by default. To enable it you must put the section-label after the \ref cfg_enabled_sections "ENABLED_SECTIONS" tag in the configuration file. Conditional blocks can be nested. A nested section is @@ -900,7 +900,7 @@ Public/Protected/Private/... section. \subsection cmdanchor \anchor <word> \addindex \anchor - This command places an invisible, named anchor into to documentation + This command places an invisible, named anchor into the documentation to which you can refer with the \\ref command. \sa section \ref cmdref "\\ref". @@ -1235,13 +1235,13 @@ Public/Protected/Private/... section. will result in the following text:<br><br> ... this is a \e really good example ... - Equvalent to \ref cmdem "\\em" + Equivalent to \ref cmdem "\\em" <hr> \subsection cmdem \em <word> \addindex \e - Displays the argument \<word\> in italics. + Displayis the argument \<word\> in italics. Use this command to emphasize words. \par Example: diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc index fe5f8f8..72dc397 100644 --- a/doc/doxysearch_usage.doc +++ b/doc/doxysearch_usage.doc @@ -68,7 +68,7 @@ follow these steps: documentation. Apart from the documentation, Doxygen will create the following files: <ul> - <li>A small shell script. the name of the script is determined by the + <li>A small shell script. The name of the script is determined by the \c CGI_NAME tag in the configuration file. The script is a small wrapper that calls \c doxysearch with the correct parameters. Using this script allows multiple diff --git a/doc/faq.doc b/doc/faq.doc index 4245a74..38d553a 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -73,7 +73,7 @@ Alternatively, you can put all members in a group (or module) using the \\ingroup command and then document the group using a comment block containing the \\defgroup command. -<li><b>How can I avoid that some code fragment is parsed by Doxyen?</b> +<li><b>How can I make doxygen ignore some code fragment?</b> <p> You can use Doxygen's preprocessor for this: If you put @@ -164,7 +164,7 @@ In the HEAD section of the HTML page. <li><b>Why does doxygen use Qt?</b> -The most important reason is too have a platform abstraction for most +The most important reason is to have a platform abstraction for most Unices and Windows by means of the QFile, QFileInfo, QDir, QDate, QTime and QIODevice classes. Another reason is for the nice and bug free utility classes, like QList, diff --git a/doc/starting.doc b/doc/starting.doc index 852ff70..927d2a0 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -111,11 +111,11 @@ format. The default output directory is the directory in which \c doxygen is started. The directory to which the output is written can be changed -using the \ref cfg_output_directory "OUTPUT_DIRECTORY" , -\ref cfg_html_output "HTML_OUTPUT", \ref cfg_latex_output "LATEX_OUTPUT", -and \ref cfg_man_output "MAN_OUTPUT" tags of the configuration file. -If the output directory does not exist, \c doxygen will try to create it -for you. +using the \ref cfg_output_directory "OUTPUT_DIRECTORY", +\ref cfg_html_output "HTML_OUTPUT", \ref cfg_rtf_output "RTF_OUTPUT", +\ref cfg_latex_output "LATEX_OUTPUT", and \ref cfg_man_output "MAN_OUTPUT" +tags of the configuration file. If the output directory does not exist, +\c doxygen will try to create it for you. \addindex browser The generated HTML documentation can be viewed by pointing a HTML browser |