Release-1.3.9.1-20041228

1 files changed, 65 insertions, 138 deletions

diff --git a/src/config.l b/src/config.l
index 06bf179..972f3d3 100644
--- a/src/config.l
+++ b/src/config.l
@@ -1139,113 +1139,6 @@ void Config::check()
     examplePatternList.append("*");
   }
 
-  // add default pattern if needed
-  //QStrList &imagePatternList = Config_getList("IMAGE_PATTERNS");
-  //if (imagePatternList.isEmpty())
-  //{
-  //  imagePatternList.append("*");
-  //}
-  
-  // more checks needed if and only if the search engine is enabled.
-//  if (Config_getBool("SEARCHENGINE"))
-//  {
-//    // check cgi name
-//    QCString &cgiName = Config_getString("CGI_NAME");
-//    if (cgiName.isEmpty())
-//    {
-//      config_err("Error: tag CGI_NAME: no cgi script name after the CGI_NAME tag.\n");
-//      exit(1);
-//    }
-//    // check cgi URL
-//    QCString &cgiURL = Config_getString("CGI_URL");
-//    if (cgiURL.isEmpty())
-//    {
-//      config_err("Error: tag CGI_URL: no URL to cgi directory specified.\n");
-//      exit(1);
-//    }
-//    else if (cgiURL.left(7)!="http://" && 
-//	     cgiURL.left(8)!="https://" &&
-//	     cgiURL.left(4)!="cgi:"
-//	    )
-//    {
-//      config_err("Error: tag CGI_URL: URL to cgi directory is invalid (must "
-//	  "start with http:// or https://).\n");
-//      exit(1);
-//    }
-//    // check documentation URL
-//    QCString &docURL = Config_getString("DOC_URL");
-//    if (docURL.isEmpty())
-//    {
-//      docURL = Config_getString("OUTPUT_DIRECTORY").copy().prepend("file://").append("html");
-//    }
-//    else if (docURL.left(7)!="http://" && 
-//	     docURL.left(8)!="https://" &&
-//	     docURL.left(7)!="file://"
-//	    )
-//    {
-//      config_err("Error: tag DOC_URL: URL to documentation is invalid or "
-//	  "not absolute.\n"); 
-//      exit(1);
-//    }
-//    // check absolute documentation path
-//    QCString &docAbsPath = Config_getString("DOC_ABSPATH");
-//    if (docAbsPath.isEmpty())
-//    {
-//      docAbsPath = Config_getString("OUTPUT_DIRECTORY")+"/html"; 
-//    }
-//    else if (docAbsPath[0]!='/' && docAbsPath[1]!=':')
-//    {
-//      config_err("Error: tag DOC_ABSPATH: path is not absolute!\n");
-//      exit(1);
-//    }
-//    // check path to doxysearch
-//    QCString &binAbsPath = Config_getString("BIN_ABSPATH");
-//    if (binAbsPath.isEmpty())
-//    {
-//      config_err("Error: tag BIN_ABSPATH: no absolute path to doxysearch "
-//	  "specified.\n");
-//      exit(1);
-//    }
-//    else if (binAbsPath[0]!='/' && binAbsPath[1]!=':')
-//    {
-//      config_err("Error: tag BIN_ABSPATH: path is not absolute!\n");
-//      exit(1);
-//    }
-//
-//  }
-//  // check perl path
-//  bool found=FALSE;
-//  QCString &perlPath = Config_getString("PERL_PATH");
-//  if (perlPath.isEmpty())
-//  {
-//    QFileInfo fi;
-//    fi.setFile("/usr/bin/perl");
-//    if (fi.exists()) 
-//    {
-//      perlPath="/usr/bin/perl";
-//      found=TRUE;
-//    }
-//    else
-//    {
-//      fi.setFile("/usr/local/bin/perl");
-//      if (fi.exists())
-//      {
-//	perlPath="/usr/local/bin/perl";
-//	found=TRUE;
-//      }
-//    }
-//  }
-//  if (!found)
-//  {
-//    QFileInfo fi(perlPath);
-//    if (!fi.exists())
-//    {
-//      config_warn("Warning: tag PERL_PATH: perl interpreter not found at default or"
-//	  "user specified (%s) location\n",
-//	  perlPath.data());
-//    }
-//  }
-
 #undef PUTENV
 #undef SEP
 #if defined(_WIN32) && !defined(__GNUC__) && (__BORLANDC__ < 0x0550)
@@ -1352,9 +1245,9 @@ void Config::create()
                  "If the CREATE_SUBDIRS tag is set to YES, then doxygen will create \n"
                  "4096 sub-directories (in 2 levels) under the output directory of each output \n"
 		 "format and will distribute the generated files over these directories. \n"
-		 "Enabling this option can be useful when feeding doxygen a huge amount of source \n"
-		 "files, where putting all generated files in the same directory would otherwise \n"
-		 "cause performance problems for the file system. \n",
+		 "Enabling this option can be useful when feeding doxygen a huge amount of \n"
+		 "source files, where putting all generated files in the same directory would \n"
+		 "otherwise cause performance problems for the file system. \n",
 		 FALSE
                 );
   ce = addEnum(
@@ -1490,11 +1383,12 @@ void Config::create()
                     "This tag implements a quasi-intelligent brief description abbreviator \n"
                     "that is used to form the text in various listings. Each string \n"
                     "in this list, if found as the leading text of the brief description, will be \n"
-                    "stripped from the text and the result after processing the whole list, is used \n"
-		    "as the annotated text. Otherwise, the brief description is used as-is. If left \n"
-		    "blank, the following values are used (\"$name\" is automatically replaced with the \n"
-		    "name of the entity): \"The $name class\" \"The $name widget\" \"The $name file\" \n"
-		    "\"is\" \"provides\" \"specifies\" \"contains\" \"represents\" \"a\" \"an\" \"the\"\n"
+                    "stripped from the text and the result after processing the whole list, is \n"
+		    "used as the annotated text. Otherwise, the brief description is used as-is. \n"
+		    "If left blank, the following values are used (\"$name\" is automatically \n"
+		    "replaced with the name of the entity): \"The $name class\" \"The $name widget\" \n"
+		    "\"The $name file\" \"is\" \"provides\" \"specifies\" \"contains\" \n"
+		    "\"represents\" \"a\" \"an\" \"the\"\n"
                  );
   cb = addBool(
                     "ALWAYS_DETAILED_SEC",
@@ -1505,10 +1399,10 @@ void Config::create()
                  );
   cb = addBool(
                     "INLINE_INHERITED_MEMB",
-                    "If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited \n"
-                    "members of a class in the documentation of that class as if those members were \n"
-		    "ordinary class members. Constructors, destructors and assignment operators of \n"
-		    "the base classes will not be shown. \n",
+                    "If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all \n"
+		    "inherited members of a class in the documentation of that class as if those \n"
+		    "members were ordinary class members. Constructors, destructors and assignment \n"
+		    "operators of the base classes will not be shown. \n",
 		    FALSE
                  );
   cb = addBool(
@@ -1602,8 +1496,8 @@ void Config::create()
                  );
   cb = addBool(
                     "OPTIMIZE_OUTPUT_FOR_C",
-                    "Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources \n"
-                    "only. Doxygen will then generate output that is more tailored for C. \n"
+                    "Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C \n"
+		    "sources only. Doxygen will then generate output that is more tailored for C. \n"
                     "For instance, some of the names that are used will be different. The list \n"
                     "of all members will be omitted, etc. \n",
                     FALSE
@@ -1823,6 +1717,15 @@ void Config::create()
 		    "in the documentation.\n",
 		    TRUE
               );
+  cs = addString(  "FILE_VERSION_FILTER",
+                   "The FILE_VERSION_FILTER tag can be used to specify a program or script that \n"
+		   "doxygen should invoke to get the current version for each file (typically from the \n"
+		   "version control system). Doxygen will invoke the program by executing (via \n"
+		   "popen()) the command <command> <input-file>, where <command> is the value of \n"
+		   "the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file \n"
+		   "provided by doxygen. Whatever the progam writes to standard output \n"
+		   "is used as the file version. See the manual for examples. \n"
+              );
   
   //-----------------------------------------------------------------------------------------------
   addInfo(  "Messages","configuration options related to warning and progress messages");
@@ -1869,7 +1772,9 @@ void Config::create()
                     "The WARN_FORMAT tag determines the format of the warning messages that \n"
                     "doxygen can produce. The string should contain the $file, $line, and $text \n"
                     "tags, which will be replaced by the file and line number from which the \n"
-                    "warning originated and the warning text. \n"
+                    "warning originated and the warning text. Optionally the format may contain \n"
+		    "$version, which will be replaced by the version of the file (if it could \n"
+		    "be obtained via FILE_VERSION_FILTER)\n"
                    ); 
   cs->setDefaultValue("$file:$line: $text");
   cs = addString(
@@ -1895,8 +1800,8 @@ void Config::create()
                     "FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \n"
                     "and *.h) to filter out the source-files in the directories. If left \n"
                     "blank the following patterns are tested: \n"
-		    "*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp \n"
-		    "*.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm\n"
+		    "*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx \n"
+		    "*.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm\n"
                  );
   cb = addBool(
                     "RECURSIVE",
@@ -1913,8 +1818,9 @@ void Config::create()
                  );
   cb = addBool(
                     "EXCLUDE_SYMLINKS",
-                    "The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories \n"
-                    "that are symbolic links (a Unix filesystem feature) are excluded from the input. \n",
+                    "The EXCLUDE_SYMLINKS tag can be used select whether or not files or \n"
+		    "directories that are symbolic links (a Unix filesystem feature) are excluded \n"
+		    "from the input. \n",
                     FALSE
                  );
   cl->setWidgetType(ConfigList::FileAndDir);
@@ -2556,8 +2462,8 @@ void Config::create()
                     "If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then \n"
 		    "doxygen's preprocessor will remove all function-like macros that are alone \n"
 		    "on a line, have an all uppercase name, and do not end with a semicolon. Such \n"
-		    "function macros are typically used for boiler-plate code, and will confuse the \n"
-		    "parser if not removed. \n",
+		    "function macros are typically used for boiler-plate code, and will confuse \n"
+		    "the parser if not removed. \n",
                     TRUE
                  );
   cb->addDependency("ENABLE_PREPROCESSING");
@@ -2616,10 +2522,11 @@ void Config::create()
   cb = addBool(
                     "CLASS_DIAGRAMS",
                     "If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will \n"
-                    "generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or \n"
-                    "super classes. Setting the tag to NO turns the diagrams off. Note that this \n"
-		    "option is superseded by the HAVE_DOT option below. This is only a fallback. It is \n"
-		    "recommended to install and use dot, since it yields more powerful graphs. \n",
+                    "generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base \n"
+		    "or super classes. Setting the tag to NO turns the diagrams off. Note that \n"
+		    "this option is superseded by the HAVE_DOT option below. This is only a \n"
+		    "fallback. It is recommended to install and use dot, since it yields more \n"
+		    "powerful graphs. \n",
                     TRUE
                  );
   cb = addBool(
@@ -2770,16 +2677,36 @@ void Config::create()
                     "MAX_DOT_GRAPH_DEPTH",
                     "The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the \n"
                     "graphs generated by dot. A depth value of 3 means that only nodes reachable \n"
-                    "from the root by following a path via at most 3 edges will be shown. Nodes that \n"
-		    "lay further from the root node will be omitted. Note that setting this option to \n"
-		    "1 or 2 may greatly reduce the computation time needed for large code bases. Also \n"
-		    "note that a graph may be further truncated if the graph's image dimensions are \n"
-		    "not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). \n"
-		    "If 0 is used for the depth value (the default), the graph is not depth-constrained. \n",
+                    "from the root by following a path via at most 3 edges will be shown. Nodes \n"
+		    "that lay further from the root node will be omitted. Note that setting this \n"
+		    "option to 1 or 2 may greatly reduce the computation time needed for large \n"
+		    "code bases. Also note that a graph may be further truncated if the graph's \n"
+		    "image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH \n"
+		    "and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), \n"
+		    "the graph is not depth-constrained. \n",
                     0,1000,0
                 );
   ci->addDependency("HAVE_DOT");
   cb = addBool(
+                    "DOT_TRANSPARENT",
+		    "Set the DOT_TRANSPARENT tag to YES to generate images with a transparent \n"
+		    "background. This is disabled by default, which results in a white background. \n"
+		    "Warning: Depending on the platform used, enabling this option may lead to \n"
+		    "badly anti-aliased labels on the edges of a graph (i.e. they become hard to \n"
+		    "read). \n",
+		    FALSE
+              );
+  cb->addDependency("HAVE_DOT");
+  cb = addBool(
+                    "DOT_MULTI_TARGETS",
+		    "Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output \n"
+		    "files in one run (i.e. multiple -o and -T options on the command line). This \n"
+		    "makes dot run faster, but since only newer versions of dot (>1.8.10) \n"
+		    "support this, this feature is disabled by default. \n",
+		    FALSE
+              );
+  cb->addDependency("HAVE_DOT");
+  cb = addBool(
                     "GENERATE_LEGEND",
                     "If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will \n"
                     "generate a legend page explaining the meaning of the various boxes and \n"