Release-1.7.3-20110123

1 files changed, 34 insertions, 2 deletions

diff --git a/doc/config.doc b/doc/config.doc
index 759021a..8c72a23 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -2,7 +2,7 @@
  *
  * 
  *
- * Copyright (C) 1997-2008 by Dimitri van Heesch.
+ * Copyright (C) 1997-2011 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 
@@ -214,6 +214,8 @@ followed by the descriptions of the tags grouped by category.
 \refitem cfg_perlmod_makevar_prefix PERLMOD_MAKEVAR_PREFIX
 \refitem cfg_perlmod_pretty PERLMOD_PRETTY
 \refitem cfg_predefined PREDEFINED
+\refitem cfg_project_brief PROJECT_BRIEF
+\refitem cfg_project_logo PROJECT_LOGO
 \refitem cfg_project_name PROJECT_NAME
 \refitem cfg_project_number PROJECT_NUMBER
 \refitem cfg_qch_file QCH_FILE
@@ -308,6 +310,19 @@ followed by the descriptions of the tags grouped by category.
  This could be handy for archiving the generated documentation or
  if some version control system is used.
 
+\anchor cfg_project_brief
+<dt>\c PROJECT_BRIEF <dd>
+ Using the \c PROJECT_BRIEF tag one can provide an optional one line description 
+ for a project that appears at the top of each page and should give viewer 
+ a quick idea about the purpose of the project. Keep the description short. 
+
+\anchor cfg_project_logo
+<dt>\c PROJECT_LOGO <dd>
+ With the \c PROJECT_LOGO tag one can specify an logo or icon that is 
+ included in the documentation. The maximum height of the logo should not 
+ exceed 55 pixels and the maximum width should not exceed 200 pixels. 
+ Doxygen will copy the logo to the output directory.
+
 \anchor cfg_output_directory
 <dt>\c OUTPUT_DIRECTORY <dd> 
  \addindex OUTPUT_DIRECTORY
@@ -1291,6 +1306,10 @@ AClass::ANamespace, ANamespace::*Test
             the project (see \c PROJECT_NAME)
  <dt><code>\$projectnumber</code><dd>will be replaced with the project number
             (see \c PROJECT_NUMBER)
+ <dt><code>\$projectbrief</code><dd>will be replaced with the project brief
+            description (see \c PROJECT_BRIEF)
+ <dt><code>\$projectlogo</code><dd>will be replaced with the project logo
+            (see \c PROJECT_LOGO)
  <dt><code>\$relpath\$</code><dd>
  If \c CREATE_SUBDIRS is enabled, the command <code>\$relpath\$</code> can be 
  used to produce a relative path to the root of the HTML output directory,
@@ -1299,6 +1318,19 @@ AClass::ANamespace, ANamespace::*Test
    
  See also section \ref doxygen_usage for information on how to generate
  the default header that doxygen normally uses.
+
+ @note When using a custom header you are responsible
+ for the proper inclusion of any scripts and style sheets that doxygen
+ needs, which is dependent on the configuration options used.
+ It is adviced to generate a default header using
+\verbatim
+doxygen -w html header.html footer.html stylesheet.css YourConfigFile
+\endverbatim
+ and then modify that header.
+
+ @note The header is subject to change so you typically
+ have to redo this when upgrading to a newer version of doxygen or when
+ changing the value of configuration settings such as \c GENERATE_TREEVIEW!
    
 \anchor cfg_html_footer
 <dt>\c HTML_FOOTER <dd>
@@ -2331,7 +2363,7 @@ The default size is 10pt.
 <dt>\c DOT_IMAGE_FORMAT <dd>
  \addindex DOT_IMAGE_FORMAT
  The \c DOT_IMAGE_FORMAT tag can be used to set the image format of the images
- generated by dot. Possible values are gif, jpg, and png.
+ generated by dot. Possible values are svg, png, jpg, or gif.
  If left blank png will be used.
 
 \anchor cfg_dot_path