diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2009-08-14 14:49:07 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2009-08-14 14:49:07 (GMT) |
| commit | 8c6ca30831818a77a6947baad63ab99cb8cd8c31 (patch) | |
| tree | fed426d0d7216311cbd009a1fcd2786176478b5e /src | |
| parent | 142b4807d2ae7479691bd0800d28364b9857b82f (diff) | |
| download | Doxygen-8c6ca30831818a77a6947baad63ab99cb8cd8c31.zip Doxygen-8c6ca30831818a77a6947baad63ab99cb8cd8c31.tar.gz Doxygen-8c6ca30831818a77a6947baad63ab99cb8cd8c31.tar.bz2 | |
Release-1.5.9-20090814
Diffstat (limited to 'src')
84 files changed, 2227 insertions, 2102 deletions
diff --git a/src/classdef.cpp b/src/classdef.cpp index 168162b..26934f1 100644 --- a/src/classdef.cpp +++ b/src/classdef.cpp @@ -2041,20 +2041,24 @@ void ClassDef::writeDeclaration(OutputList &ol,MemberDef *md,bool inGroup) /*! a link to this class is possible within this project */ bool ClassDef::isLinkableInProject() const { + static bool extractPrivate = Config_getBool("EXTRACT_PRIVATE"); + static bool extractLocal = Config_getBool("EXTRACT_LOCAL_CLASSES"); + static bool extractStatic = Config_getBool("EXTRACT_STATIC"); + static bool hideUndoc = Config_getBool("HIDE_UNDOC_CLASSES"); if (m_impl->templateMaster) { return m_impl->templateMaster->isLinkableInProject(); } else { - return !name().isEmpty() && /* no name */ - !isArtificial() && !isHidden() && - name().find('@')==-1 && /* anonymous compound */ - (m_impl->prot!=Private || Config_getBool("EXTRACT_PRIVATE")) && /* private */ - (!m_impl->isLocal || Config_getBool("EXTRACT_LOCAL_CLASSES")) && /* local */ - hasDocumentation() && /* documented */ - !isReference() && /* not an external reference */ - (!m_impl->isStatic || Config_getBool("EXTRACT_STATIC")); + return !name().isEmpty() && /* has a name */ + !isArtificial() && !isHidden() && /* not hidden */ + name().find('@')==-1 && /* not anonymous */ + (m_impl->prot!=Private || extractPrivate) && /* private */ + (!m_impl->isLocal || extractLocal) && /* local */ + (hasDocumentation() || !hideUndoc) && /* documented */ + (!m_impl->isStatic || extractStatic) && /* static */ + !isReference(); /* not an external reference */ } } diff --git a/src/classlist.cpp b/src/classlist.cpp index ee23331..85c6174 100644 --- a/src/classlist.cpp +++ b/src/classlist.cpp @@ -155,7 +155,7 @@ void ClassSDict::writeDeclaration(OutputList &ol,const ClassDef::CompoundType *f { ol.startMemberDescription(); ol.parseDoc(cd->briefFile(),cd->briefLine(),cd,0, - cd->briefDescription(),FALSE,FALSE); + cd->briefDescription(),FALSE,FALSE,0,TRUE,FALSE); if (//(!cd->briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF")) || //!cd->documentation().isEmpty()) cd->isLinkableInProject() @@ -410,6 +410,9 @@ static void popScope() static void setCurrentDoc(const QCString &name,const QCString &base,const QCString &anchor="") { + (void)name; + (void)base; + (void)anchor; //static bool searchEngineEnabled=Config_getBool("SEARCHENGINE") && // Config_getBool("SOURCE_BROWSER"); //if (searchEngineEnabled) @@ -420,6 +423,7 @@ static void setCurrentDoc(const QCString &name,const QCString &base,const QCStri static void addToSearchIndex(const char *text) { + (void)text; //static bool searchEngineEnabled=Config_getBool("SEARCHENGINE") && // Config_getBool("SOURCE_BROWSER"); //if (searchEngineEnabled) @@ -539,7 +543,7 @@ static void codifyLines(char *text) while (!done) { sp=p; - while ((c=*p++) && c!='\n'); + while ((c=*p++) && c!='\n') { } if (c=='\n') { g_yyLineNr++; @@ -574,7 +578,7 @@ static void writeMultiLineCodeLink(CodeOutputInterface &ol, { char *sp=p; char c; - while ((c=*p++) && c!='\n'); + while ((c=*p++) && c!='\n') { } if (c=='\n') { g_yyLineNr++; diff --git a/src/commentscan.l b/src/commentscan.l index 0ddb9fa..88f4008 100644 --- a/src/commentscan.l +++ b/src/commentscan.l @@ -512,8 +512,8 @@ static void addXRefItem(const char *listName,const char *itemTitle, { if (strcmp(lii->type,listName)==0) { - //printf("found %s lii->type=%s\n",listName,lii->type); - break; + //printf("found %s lii->type=%s\n",listName,lii->type); + break; } } } @@ -534,7 +534,8 @@ static void addXRefItem(const char *listName,const char *itemTitle, // if we have already an item from the same list type (e.g. a second @todo) // in the same Entry (i.e. lii!=0) then we reuse its link anchor. char anchorLabel[1024]; - sprintf(anchorLabel,"_%s%06d",listName,lii ? lii->itemId : itemId); + //sprintf(anchorLabel,"_%s%06d",listName,lii ? lii->itemId : itemId); + sprintf(anchorLabel,"_%s%06d",listName,itemId); RefItem *item = refList->getRefItem(itemId); ASSERT(item!=0); item->text = outputXRef; @@ -621,7 +622,8 @@ static inline void setOutput(OutputContext ctx) { bool xrefAppendToPrev = xrefAppendFlag; // determine append flag for the next item (i.e. the end of this item) - xrefAppendFlag = inContext==OutputXRef && ctx==OutputXRef && // two consecutive xref items + xrefAppendFlag = !inBody && + inContext==OutputXRef && ctx==OutputXRef && // two consecutive xref items newXRefKind==xrefKind && // of the same kind (xrefKind!=XRef_Item || newXRefItemKey==xrefItemKey); // with the same key if \xrefitem diff --git a/src/compound.xsd b/src/compound.xsd index a200f8b..94b0f86 100644 --- a/src/compound.xsd +++ b/src/compound.xsd @@ -163,6 +163,11 @@ <xsd:attribute name="add" type="DoxBool" use="optional"/> <xsd:attribute name="remove" type="DoxBool" use="optional"/> <xsd:attribute name="raise" type="DoxBool" use="optional"/> + <!-- Objective-C 2.0 protocol method --> + <xsd:attribute name="optional" type="DoxBool" use="optional"/> + <xsd:attribute name="required" type="DoxBool" use="optional"/> + <!-- Objective-C 2.0 property accessor --> + <xsd:attribute name="accessor" type="DoxAccessor" use="optional"/> </xsd:complexType> <xsd:complexType name="descriptionType" mixed="true"> @@ -793,5 +798,13 @@ </xsd:restriction> </xsd:simpleType> + <xsd:simpleType name="DoxAccessor"> + <xsd:restriction base="xsd:string"> + <xsd:enumeration value="retain"/> + <xsd:enumeration value="copy"/> + <xsd:enumeration value="assign"/> + </xsd:restriction> + </xsd:simpleType> + </xsd:schema> diff --git a/src/compound_xsd.h b/src/compound_xsd.h index 47de4d3..a4deb0b 100644 --- a/src/compound_xsd.h +++ b/src/compound_xsd.h @@ -163,6 +163,11 @@ " <xsd:attribute name=\"add\" type=\"DoxBool\" use=\"optional\"/>\n" " <xsd:attribute name=\"remove\" type=\"DoxBool\" use=\"optional\"/>\n" " <xsd:attribute name=\"raise\" type=\"DoxBool\" use=\"optional\"/>\n" +" <!-- Objective-C 2.0 protocol method -->\n" +" <xsd:attribute name=\"optional\" type=\"DoxBool\" use=\"optional\"/>\n" +" <xsd:attribute name=\"required\" type=\"DoxBool\" use=\"optional\"/>\n" +" <!-- Objective-C 2.0 property accessor -->\n" +" <xsd:attribute name=\"accessor\" type=\"DoxAccessor\" use=\"optional\"/>\n" " </xsd:complexType>\n" "\n" " <xsd:complexType name=\"descriptionType\" mixed=\"true\">\n" @@ -793,5 +798,13 @@ " </xsd:restriction>\n" " </xsd:simpleType>\n" "\n" +" <xsd:simpleType name=\"DoxAccessor\">\n" +" <xsd:restriction base=\"xsd:string\">\n" +" <xsd:enumeration value=\"retain\"/>\n" +" <xsd:enumeration value=\"copy\"/>\n" +" <xsd:enumeration value=\"assign\"/>\n" +" </xsd:restriction>\n" +" </xsd:simpleType>\n" +"\n" "</xsd:schema>\n" "\n" diff --git a/src/config.h b/src/config.h index f87b2ba..8ff2624 100644 --- a/src/config.h +++ b/src/config.h @@ -142,7 +142,7 @@ class ConfigList : public ConfigOption t << convertToComment(m_doc); t << endl; } - t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "= "; + t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; writeStringList(t,m_value); t << "\n"; } @@ -183,7 +183,7 @@ class ConfigEnum : public ConfigOption t << convertToComment(m_doc); t << endl; } - t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "= "; + t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; writeStringValue(t,m_value); t << "\n"; } @@ -225,7 +225,7 @@ class ConfigString : public ConfigOption t << convertToComment(m_doc); t << endl; } - t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "= "; + t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; writeStringValue(t,m_value); t << "\n"; } @@ -269,7 +269,7 @@ class ConfigInt : public ConfigOption t << convertToComment(m_doc); t << endl; } - t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "= "; + t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; if (upd && !m_valueString.isEmpty()) { writeStringValue(t,m_valueString); @@ -317,7 +317,7 @@ class ConfigBool : public ConfigOption t << convertToComment(m_doc); t << endl; } - t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "= "; + t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "="; if (upd && !m_valueString.isEmpty()) { writeStringValue(t,m_valueString); diff --git a/src/config.l b/src/config.l index 2ee393e..e433669 100644 --- a/src/config.l +++ b/src/config.l @@ -77,20 +77,26 @@ static QCString configStringRecode( /* ----------------------------------------------------------------- */ - QCString ConfigOption::convertToComment(const QCString &s) { QCString result; if (s.isEmpty()) return result; else { - result+="# "; QCString tmp=s.stripWhiteSpace(); char *p=tmp.data(); char c; + result+="#"; + if (*p && *p!='\n') + result+=" "; while ((c=*p++)) { - if (c=='\n') result+="\n# "; + if (c=='\n') + { + result+="\n#"; + if (*p && *p!='\n') + result+=" "; + } else result+=c; } result+='\n'; @@ -100,12 +106,13 @@ QCString ConfigOption::convertToComment(const QCString &s) void ConfigOption::writeBoolValue(QTextStream &t,bool v) { + t << " "; if (v) t << "YES"; else t << "NO"; } void ConfigOption::writeIntValue(QTextStream &t,int i) { - t << i; + t << " " << i; } void ConfigOption::writeStringValue(QTextStream &t,QCString &s) @@ -117,6 +124,7 @@ void ConfigOption::writeStringValue(QTextStream &t,QCString &s) const char *p=se.data(); if (p) { + t << " "; while ((c=*p++)!=0 && !needsEscaping) needsEscaping = (c==' ' || c=='\n' || c=='\t' || c=='"' || c=='#'); if (needsEscaping) @@ -145,7 +153,8 @@ void ConfigOption::writeStringList(QTextStream &t,QStrList &l) while (p) { QCString s=p; - if (!first) t << " "; + if (!first) + t << " "; first=FALSE; writeStringValue(t,s); p = l.next(); diff --git a/src/config.xml b/src/config.xml index 55d809d..aa09dcb 100644 --- a/src/config.xml +++ b/src/config.xml @@ -393,6 +393,14 @@ brief documentation of file, namespace and class members alphabetically by member name. If set to NO (the default) the members will appear in declaration order. ' defval='0'/> + <option type='bool' id='SORT_MEMBERS_CTORS_1ST' docs=' +If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +will sort the (brief and detailed) documentation of class members so that +constructors and destructors are listed first. If set to NO (the default) +the constructors will appear in the respective orders defined by +SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.' defval='0'/> <option type='bool' id='SORT_GROUP_NAMES' docs=' If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy of group names into alphabetical order. If set to NO (the default) @@ -1101,7 +1109,7 @@ are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful so different doxyrules.make files included by the same Makefile don't overwrite each other's variables.' defval='' depends='GENERATE_PERLMOD'/> </group> - <group name='Preprocessor' docs='Configuration options related to the preprocessor '> + <group name='Preprocessor' docs='Configuration options related to the preprocessor'> <option type='bool' id='ENABLE_PREPROCESSING' docs=' If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will evaluate all C-preprocessor directives found in the sources and include @@ -1160,7 +1168,7 @@ function macros are typically used for boiler-plate code, and will confuse the parser if not removed. ' defval='1' depends='ENABLE_PREPROCESSING'/> </group> - <group name='External' docs='Configuration::additions related to external references '> + <group name='External' docs='Configuration::additions related to external references'> <option type='list' id='TAGFILES' format='file' docs=' The TAGFILES option can be used to specify one or more tagfiles. Optionally an initial location of the external documentation @@ -1197,7 +1205,7 @@ The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of `which perl'). ' defval='/usr/bin/perl'/> </group> - <group name='Dot' docs='Configuration options related to the dot tool '> + <group name='Dot' docs='Configuration options related to the dot tool'> <option type='bool' id='CLASS_DIAGRAMS' docs=' If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base diff --git a/src/configgen.py b/src/configgen.py index c58464d..f567127 100755 --- a/src/configgen.py +++ b/src/configgen.py @@ -29,7 +29,7 @@ def parseOption(node): adefval = node.getAttribute('altdefval') depends = node.getAttribute('depends') # replace \ by \\, replace " by \", and ' ' by a newline with end string and start string at next line - docC = doc.strip().replace('\\','\\\\').replace('"','\\"').replace(' ',' \\n"\n "') + docC = doc.strip().replace('\\','\\\\').replace('"','\\"').replace(' ','\\n"\n "') print " //----" if type=='bool': if len(adefval)>0: diff --git a/src/configoptions.cpp b/src/configoptions.cpp index d87fb24..9d9c489 100644 --- a/src/configoptions.cpp +++ b/src/configoptions.cpp @@ -22,58 +22,58 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "DOXYFILE_ENCODING", - "This tag specifies the encoding used for all characters in the config file \n" - "that follow. The default is UTF-8 which is also the encoding used for all \n" - "text before the first occurrence of this tag. Doxygen uses libiconv (or the \n" - "iconv built into libc) for the transcoding. See \n" + "This tag specifies the encoding used for all characters in the config file\n" + "that follow. The default is UTF-8 which is also the encoding used for all\n" + "text before the first occurrence of this tag. Doxygen uses libiconv (or the\n" + "iconv built into libc) for the transcoding. See\n" "http://www.gnu.org/software/libiconv for the list of possible encodings." ); cs->setDefaultValue("UTF-8"); //---- cs = cfg->addString( "PROJECT_NAME", - "The PROJECT_NAME tag is a single word (or a sequence of words surrounded \n" + "The PROJECT_NAME tag is a single word (or a sequence of words surrounded\n" "by quotes) that should identify the project." ); //---- cs = cfg->addString( "PROJECT_NUMBER", - "The PROJECT_NUMBER tag can be used to enter a project or revision number. \n" - "This could be handy for archiving the generated documentation or \n" + "The PROJECT_NUMBER tag can be used to enter a project or revision number.\n" + "This could be handy for archiving the generated documentation or\n" "if some version control system is used." ); //---- cs = cfg->addString( "OUTPUT_DIRECTORY", - "The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) \n" - "base path where the generated documentation will be put. \n" - "If a relative path is entered, it will be relative to the location \n" + "The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)\n" + "base path where the generated documentation will be put.\n" + "If a relative path is entered, it will be relative to the location\n" "where doxygen was started. If left blank the current directory will be used." ); cs->setWidgetType(ConfigString::Dir); //---- cb = cfg->addBool( "CREATE_SUBDIRS", - "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 \n" - "source files, where putting all generated files in the same directory would \n" + "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\n" + "source files, where putting all generated files in the same directory would\n" "otherwise cause performance problems for the file system.", FALSE ); //---- ce = cfg->addEnum( "OUTPUT_LANGUAGE", - "The OUTPUT_LANGUAGE tag is used to specify the language in which all \n" - "documentation generated by doxygen is written. Doxygen will use this \n" - "information to generate all constant output in the proper language. \n" - "The default language is English, other supported languages are: \n" - "Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, \n" - "Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, \n" - "Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English \n" - "messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, \n" - "Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, \n" + "The OUTPUT_LANGUAGE tag is used to specify the language in which all\n" + "documentation generated by doxygen is written. Doxygen will use this\n" + "information to generate all constant output in the proper language.\n" + "The default language is English, other supported languages are:\n" + "Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,\n" + "Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,\n" + "Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English\n" + "messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,\n" + "Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,\n" "Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.", "English" ); @@ -118,32 +118,32 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "BRIEF_MEMBER_DESC", - "If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will \n" - "include brief member descriptions after the members that are listed in \n" - "the file and class documentation (similar to JavaDoc). \n" + "If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will\n" + "include brief member descriptions after the members that are listed in\n" + "the file and class documentation (similar to JavaDoc).\n" "Set to NO to disable this.", TRUE ); //---- cb = cfg->addBool( "REPEAT_BRIEF", - "If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend \n" - "the brief description of a member or function before the detailed description. \n" - "Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the \n" + "If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend\n" + "the brief description of a member or function before the detailed description.\n" + "Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\n" "brief descriptions will be completely suppressed.", TRUE ); //---- cl = cfg->addList( "ABBREVIATE_BRIEF", - "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 \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" + "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\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\"" ); cl->addValue("The $name class"); @@ -160,36 +160,36 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "ALWAYS_DETAILED_SEC", - "If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then \n" - "Doxygen will generate a detailed section even if there is only a brief \n" + "If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\n" + "Doxygen will generate a detailed section even if there is only a brief\n" "description.", FALSE ); //---- cb = cfg->addBool( "INLINE_INHERITED_MEMB", - "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" + "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.", FALSE ); //---- cb = cfg->addBool( "FULL_PATH_NAMES", - "If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full \n" - "path before files name in the file list and in the header files. If set \n" + "If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full\n" + "path before files name in the file list and in the header files. If set\n" "to NO the shortest path that makes the file name unique will be used.", TRUE ); //---- cl = cfg->addList( "STRIP_FROM_PATH", - "If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag \n" - "can be used to strip a user-defined part of the path. Stripping is \n" - "only done if one of the specified strings matches the left-hand part of \n" - "the path. The tag can be used to show relative paths in the file list. \n" - "If left blank the directory from which doxygen is run is used as the \n" + "If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag\n" + "can be used to strip a user-defined part of the path. Stripping is\n" + "only done if one of the specified strings matches the left-hand part of\n" + "the path. The tag can be used to show relative paths in the file list.\n" + "If left blank the directory from which doxygen is run is used as the\n" "path to strip." ); cl->addValue("/Users/dimitri/doxygen/mail/1.5.7/doxywizard/"); @@ -197,213 +197,213 @@ void addConfigOptions(Config *cfg) //---- cl = cfg->addList( "STRIP_FROM_INC_PATH", - "The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of \n" - "the path mentioned in the documentation of a class, which tells \n" - "the reader which header file to include in order to use a class. \n" - "If left blank only the name of the header file containing the class \n" - "definition is used. Otherwise one should specify the include paths that \n" + "The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of\n" + "the path mentioned in the documentation of a class, which tells\n" + "the reader which header file to include in order to use a class.\n" + "If left blank only the name of the header file containing the class\n" + "definition is used. Otherwise one should specify the include paths that\n" "are normally passed to the compiler using the -I flag." ); //---- cb = cfg->addBool( "SHORT_NAMES", - "If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter \n" - "(but less readable) file names. This can be useful is your file systems \n" + "If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter\n" + "(but less readable) file names. This can be useful is your file systems\n" "doesn't support long names like on DOS, Mac, or CD-ROM.", FALSE ); //---- cb = cfg->addBool( "JAVADOC_AUTOBRIEF", - "If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \n" - "will interpret the first line (until the first dot) of a JavaDoc-style \n" - "comment as the brief description. If set to NO, the JavaDoc \n" - "comments will behave just like regular Qt-style comments \n" + "If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen\n" + "will interpret the first line (until the first dot) of a JavaDoc-style\n" + "comment as the brief description. If set to NO, the JavaDoc\n" + "comments will behave just like regular Qt-style comments\n" "(thus requiring an explicit @brief command for a brief description.)", FALSE ); //---- cb = cfg->addBool( "QT_AUTOBRIEF", - "If the QT_AUTOBRIEF tag is set to YES then Doxygen will \n" - "interpret the first line (until the first dot) of a Qt-style \n" - "comment as the brief description. If set to NO, the comments \n" - "will behave just like regular Qt-style comments (thus requiring \n" + "If the QT_AUTOBRIEF tag is set to YES then Doxygen will\n" + "interpret the first line (until the first dot) of a Qt-style\n" + "comment as the brief description. If set to NO, the comments\n" + "will behave just like regular Qt-style comments (thus requiring\n" "an explicit \\brief command for a brief description.)", FALSE ); //---- cb = cfg->addBool( "MULTILINE_CPP_IS_BRIEF", - "The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen \n" - "treat a multi-line C++ special comment block (i.e. a block of //! or /// \n" - "comments) as a brief description. This used to be the default behaviour. \n" - "The new default is to treat a multi-line C++ comment block as a detailed \n" + "The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen\n" + "treat a multi-line C++ special comment block (i.e. a block of //! or ///\n" + "comments) as a brief description. This used to be the default behaviour.\n" + "The new default is to treat a multi-line C++ comment block as a detailed\n" "description. Set this tag to YES if you prefer the old behaviour instead.", FALSE ); //---- cb = cfg->addBool( "INHERIT_DOCS", - "If the INHERIT_DOCS tag is set to YES (the default) then an undocumented \n" - "member inherits the documentation from any documented member that it \n" + "If the INHERIT_DOCS tag is set to YES (the default) then an undocumented\n" + "member inherits the documentation from any documented member that it\n" "re-implements.", TRUE ); //---- cb = cfg->addBool( "SEPARATE_MEMBER_PAGES", - "If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce \n" - "a new page for each member. If set to NO, the documentation of a member will \n" + "If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce\n" + "a new page for each member. If set to NO, the documentation of a member will\n" "be part of the file/class/namespace that contains it.", FALSE ); //---- ci = cfg->addInt( "TAB_SIZE", - "The TAB_SIZE tag can be used to set the number of spaces in a tab. \n" + "The TAB_SIZE tag can be used to set the number of spaces in a tab.\n" "Doxygen uses this value to replace tabs by spaces in code fragments.", 1,16,8 ); //---- cl = cfg->addList( "ALIASES", - "This tag can be used to specify a number of aliases that acts \n" - "as commands in the documentation. An alias has the form \"name=value\". \n" - "For example adding \"sideeffect=\\par Side Effects:\\n\" will allow you to \n" - "put the command \\sideeffect (or @sideeffect) in the documentation, which \n" - "will result in a user-defined paragraph with heading \"Side Effects:\". \n" + "This tag can be used to specify a number of aliases that acts\n" + "as commands in the documentation. An alias has the form \"name=value\".\n" + "For example adding \"sideeffect=\\par Side Effects:\\n\" will allow you to\n" + "put the command \\sideeffect (or @sideeffect) in the documentation, which\n" + "will result in a user-defined paragraph with heading \"Side Effects:\".\n" "You can put \\n's in the value part of an alias to insert newlines." ); //---- cb = cfg->addBool( "OPTIMIZE_OUTPUT_FOR_C", - "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" + "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.", FALSE ); //---- cb = cfg->addBool( "OPTIMIZE_OUTPUT_JAVA", - "Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java \n" - "sources only. Doxygen will then generate output that is more tailored for \n" - "Java. For instance, namespaces will be presented as packages, qualified \n" + "Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java\n" + "sources only. Doxygen will then generate output that is more tailored for\n" + "Java. For instance, namespaces will be presented as packages, qualified\n" "scopes will look different, etc.", FALSE ); //---- cb = cfg->addBool( "OPTIMIZE_FOR_FORTRAN", - "Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran \n" - "sources only. Doxygen will then generate output that is more tailored for \n" + "Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\n" + "sources only. Doxygen will then generate output that is more tailored for\n" "Fortran.", FALSE ); //---- cb = cfg->addBool( "OPTIMIZE_OUTPUT_VHDL", - "Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL \n" - "sources. Doxygen will then generate output that is tailored for \n" + "Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\n" + "sources. Doxygen will then generate output that is tailored for\n" "VHDL.", FALSE ); //---- cl = cfg->addList( "EXTENSION_MAPPING", - "Doxygen selects the parser to use depending on the extension of the files it parses. \n" - "With this tag you can assign which parser to use for a given extension. \n" - "Doxygen has a built-in mapping, but you can override or extend it using this tag. \n" - "The format is ext=language, where ext is a file extension, and language is one of \n" - "the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, \n" - "Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat \n" - ".inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), \n" + "Doxygen selects the parser to use depending on the extension of the files it parses.\n" + "With this tag you can assign which parser to use for a given extension.\n" + "Doxygen has a built-in mapping, but you can override or extend it using this tag.\n" + "The format is ext=language, where ext is a file extension, and language is one of\n" + "the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,\n" + "Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat\n" + ".inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),\n" "use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen." ); //---- cb = cfg->addBool( "BUILTIN_STL_SUPPORT", - "If you use STL classes (i.e. std::string, std::vector, etc.) but do not want \n" - "to include (a tag file for) the STL sources as input, then you should \n" - "set this tag to YES in order to let doxygen match functions declarations and \n" - "definitions whose arguments contain STL classes (e.g. func(std::string); v.s. \n" - "func(std::string) {}). This also make the inheritance and collaboration \n" + "If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n" + "to include (a tag file for) the STL sources as input, then you should\n" + "set this tag to YES in order to let doxygen match functions declarations and\n" + "definitions whose arguments contain STL classes (e.g. func(std::string); v.s.\n" + "func(std::string) {}). This also make the inheritance and collaboration\n" "diagrams that involve STL classes more complete and accurate.", FALSE ); //---- cb = cfg->addBool( "CPP_CLI_SUPPORT", - "If you use Microsoft's C++/CLI language, you should set this option to YES to \n" + "If you use Microsoft's C++/CLI language, you should set this option to YES to\n" "enable parsing support.", FALSE ); //---- cb = cfg->addBool( "SIP_SUPPORT", - "Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. \n" - "Doxygen will parse them like normal C++ but will assume all classes use public \n" + "Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.\n" + "Doxygen will parse them like normal C++ but will assume all classes use public\n" "instead of private inheritance when no explicit protection keyword is present.", FALSE ); //---- cb = cfg->addBool( "IDL_PROPERTY_SUPPORT", - "For Microsoft's IDL there are propget and propput attributes to indicate getter \n" - "and setter methods for a property. Setting this option to YES (the default) \n" - "will make doxygen to replace the get and set methods by a property in the \n" - "documentation. This will only work if the methods are indeed getting or \n" - "setting a simple type. If this is not the case, or you want to show the \n" + "For Microsoft's IDL there are propget and propput attributes to indicate getter\n" + "and setter methods for a property. Setting this option to YES (the default)\n" + "will make doxygen to replace the get and set methods by a property in the\n" + "documentation. This will only work if the methods are indeed getting or\n" + "setting a simple type. If this is not the case, or you want to show the\n" "methods anyway, you should set this option to NO.", TRUE ); //---- cb = cfg->addBool( "DISTRIBUTE_GROUP_DOC", - "If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC \n" - "tag is set to YES, then doxygen will reuse the documentation of the first \n" - "member in the group (if any) for the other members of the group. By default \n" + "If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC\n" + "tag is set to YES, then doxygen will reuse the documentation of the first\n" + "member in the group (if any) for the other members of the group. By default\n" "all members of a group must be documented explicitly.", FALSE ); //---- cb = cfg->addBool( "SUBGROUPING", - "Set the SUBGROUPING tag to YES (the default) to allow class member groups of \n" - "the same type (for instance a group of public functions) to be put as a \n" - "subgroup of that type (e.g. under the Public Functions section). Set it to \n" - "NO to prevent subgrouping. Alternatively, this can be done per class using \n" + "Set the SUBGROUPING tag to YES (the default) to allow class member groups of\n" + "the same type (for instance a group of public functions) to be put as a\n" + "subgroup of that type (e.g. under the Public Functions section). Set it to\n" + "NO to prevent subgrouping. Alternatively, this can be done per class using\n" "the \\nosubgrouping command.", TRUE ); //---- cb = cfg->addBool( "TYPEDEF_HIDES_STRUCT", - "When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum \n" - "is documented as struct, union, or enum with the name of the typedef. So \n" - "typedef struct TypeS {} TypeT, will appear in the documentation as a struct \n" - "with name TypeT. When disabled the typedef will appear as a member of a file, \n" - "namespace, or class. And the struct will be named TypeS. This can typically \n" - "be useful for C code in case the coding convention dictates that all compound \n" + "When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum\n" + "is documented as struct, union, or enum with the name of the typedef. So\n" + "typedef struct TypeS {} TypeT, will appear in the documentation as a struct\n" + "with name TypeT. When disabled the typedef will appear as a member of a file,\n" + "namespace, or class. And the struct will be named TypeS. This can typically\n" + "be useful for C code in case the coding convention dictates that all compound\n" "types are typedef'ed and only the typedef is referenced, never the tag name.", FALSE ); //---- ci = cfg->addInt( "SYMBOL_CACHE_SIZE", - "The SYMBOL_CACHE_SIZE determines the size of the internal cache use to \n" - "determine which symbols to keep in memory and which to flush to disk. \n" - "When the cache is full, less often used symbols will be written to disk. \n" - "For small to medium size projects (<1000 input files) the default value is \n" - "probably good enough. For larger projects a too small cache size can cause \n" - "doxygen to be busy swapping symbols to and from disk most of the time \n" - "causing a significant performance penality. \n" - "If the system has enough physical memory increasing the cache will improve the \n" - "performance by keeping more symbols in memory. Note that the value works on \n" - "a logarithmic scale so increasing the size by one will rougly double the \n" - "memory usage. The cache size is given by this formula: \n" - "2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, \n" + "The SYMBOL_CACHE_SIZE determines the size of the internal cache use to\n" + "determine which symbols to keep in memory and which to flush to disk.\n" + "When the cache is full, less often used symbols will be written to disk.\n" + "For small to medium size projects (<1000 input files) the default value is\n" + "probably good enough. For larger projects a too small cache size can cause\n" + "doxygen to be busy swapping symbols to and from disk most of the time\n" + "causing a significant performance penality.\n" + "If the system has enough physical memory increasing the cache will improve the\n" + "performance by keeping more symbols in memory. Note that the value works on\n" + "a logarithmic scale so increasing the size by one will rougly double the\n" + "memory usage. The cache size is given by this formula:\n" + "2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,\n" "corresponding to a cache size of 2^16 = 65536 symbols", 0,9,0 ); @@ -414,265 +414,271 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "EXTRACT_ALL", - "If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in \n" - "documentation are documented, even if no documentation was available. \n" - "Private class members and static file members will be hidden unless \n" + "If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in\n" + "documentation are documented, even if no documentation was available.\n" + "Private class members and static file members will be hidden unless\n" "the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES", FALSE ); //---- cb = cfg->addBool( "EXTRACT_PRIVATE", - "If the EXTRACT_PRIVATE tag is set to YES all private members of a class \n" + "If the EXTRACT_PRIVATE tag is set to YES all private members of a class\n" "will be included in the documentation.", FALSE ); //---- cb = cfg->addBool( "EXTRACT_STATIC", - "If the EXTRACT_STATIC tag is set to YES all static members of a file \n" + "If the EXTRACT_STATIC tag is set to YES all static members of a file\n" "will be included in the documentation.", FALSE ); //---- cb = cfg->addBool( "EXTRACT_LOCAL_CLASSES", - "If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) \n" - "defined locally in source files will be included in the documentation. \n" + "If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)\n" + "defined locally in source files will be included in the documentation.\n" "If set to NO only classes defined in header files are included.", TRUE ); //---- cb = cfg->addBool( "EXTRACT_LOCAL_METHODS", - "This flag is only useful for Objective-C code. When set to YES local \n" - "methods, which are defined in the implementation section but not in \n" - "the interface are included in the documentation. \n" + "This flag is only useful for Objective-C code. When set to YES local\n" + "methods, which are defined in the implementation section but not in\n" + "the interface are included in the documentation.\n" "If set to NO (the default) only methods in the interface are included.", FALSE ); //---- cb = cfg->addBool( "EXTRACT_ANON_NSPACES", - "If this flag is set to YES, the members of anonymous namespaces will be \n" - "extracted and appear in the documentation as a namespace called \n" - "'anonymous_namespace{file}', where file will be replaced with the base \n" - "name of the file that contains the anonymous namespace. By default \n" + "If this flag is set to YES, the members of anonymous namespaces will be\n" + "extracted and appear in the documentation as a namespace called\n" + "'anonymous_namespace{file}', where file will be replaced with the base\n" + "name of the file that contains the anonymous namespace. By default\n" "anonymous namespace are hidden.", FALSE ); //---- cb = cfg->addBool( "HIDE_UNDOC_MEMBERS", - "If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \n" - "undocumented members of documented classes, files or namespaces. \n" - "If set to NO (the default) these members will be included in the \n" - "various overviews, but no documentation section is generated. \n" + "If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all\n" + "undocumented members of documented classes, files or namespaces.\n" + "If set to NO (the default) these members will be included in the\n" + "various overviews, but no documentation section is generated.\n" "This option has no effect if EXTRACT_ALL is enabled.", FALSE ); //---- cb = cfg->addBool( "HIDE_UNDOC_CLASSES", - "If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all \n" - "undocumented classes that are normally visible in the class hierarchy. \n" - "If set to NO (the default) these classes will be included in the various \n" + "If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all\n" + "undocumented classes that are normally visible in the class hierarchy.\n" + "If set to NO (the default) these classes will be included in the various\n" "overviews. This option has no effect if EXTRACT_ALL is enabled.", FALSE ); //---- cb = cfg->addBool( "HIDE_FRIEND_COMPOUNDS", - "If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all \n" - "friend (class|struct|union) declarations. \n" - "If set to NO (the default) these declarations will be included in the \n" + "If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all\n" + "friend (class|struct|union) declarations.\n" + "If set to NO (the default) these declarations will be included in the\n" "documentation.", FALSE ); //---- cb = cfg->addBool( "HIDE_IN_BODY_DOCS", - "If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any \n" - "documentation blocks found inside the body of a function. \n" - "If set to NO (the default) these blocks will be appended to the \n" + "If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any\n" + "documentation blocks found inside the body of a function.\n" + "If set to NO (the default) these blocks will be appended to the\n" "function's detailed documentation block.", FALSE ); //---- cb = cfg->addBool( "INTERNAL_DOCS", - "The INTERNAL_DOCS tag determines if documentation \n" - "that is typed after a \\internal command is included. If the tag is set \n" - "to NO (the default) then the documentation will be excluded. \n" + "The INTERNAL_DOCS tag determines if documentation\n" + "that is typed after a \\internal command is included. If the tag is set\n" + "to NO (the default) then the documentation will be excluded.\n" "Set it to YES to include the internal documentation.", FALSE ); //---- cb = cfg->addBool( "CASE_SENSE_NAMES", - "If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate \n" - "file names in lower-case letters. If set to YES upper-case letters are also \n" - "allowed. This is useful if you have classes or files whose names only differ \n" - "in case and if your file system supports case sensitive file names. Windows \n" + "If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate\n" + "file names in lower-case letters. If set to YES upper-case letters are also\n" + "allowed. This is useful if you have classes or files whose names only differ\n" + "in case and if your file system supports case sensitive file names. Windows\n" "and Mac users are advised to set this option to NO.", portable_fileSystemIsCaseSensitive() ); //---- cb = cfg->addBool( "HIDE_SCOPE_NAMES", - "If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen \n" - "will show members with their full class and namespace scopes in the \n" + "If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen\n" + "will show members with their full class and namespace scopes in the\n" "documentation. If set to YES the scope will be hidden.", FALSE ); //---- cb = cfg->addBool( "SHOW_INCLUDE_FILES", - "If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen \n" - "will put a list of the files that are included by a file in the documentation \n" + "If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen\n" + "will put a list of the files that are included by a file in the documentation\n" "of that file.", TRUE ); //---- cb = cfg->addBool( "INLINE_INFO", - "If the INLINE_INFO tag is set to YES (the default) then a tag [inline] \n" + "If the INLINE_INFO tag is set to YES (the default) then a tag [inline]\n" "is inserted in the documentation for inline members.", TRUE ); //---- cb = cfg->addBool( "SORT_MEMBER_DOCS", - "If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen \n" - "will sort the (detailed) documentation of file and class members \n" - "alphabetically by member name. If set to NO the members will appear in \n" + "If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen\n" + "will sort the (detailed) documentation of file and class members\n" + "alphabetically by member name. If set to NO the members will appear in\n" "declaration order.", TRUE ); //---- cb = cfg->addBool( "SORT_BRIEF_DOCS", - "If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the \n" - "brief documentation of file, namespace and class members alphabetically \n" - "by member name. If set to NO (the default) the members will appear in \n" + "If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the\n" + "brief documentation of file, namespace and class members alphabetically\n" + "by member name. If set to NO (the default) the members will appear in\n" "declaration order.", FALSE ); //---- cb = cfg->addBool( + "SORT_MEMBERS_CTORS_1ST", + "If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.", + FALSE + ); + //---- + cb = cfg->addBool( "SORT_GROUP_NAMES", - "If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the \n" - "hierarchy of group names into alphabetical order. If set to NO (the default) \n" + "If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the\n" + "hierarchy of group names into alphabetical order. If set to NO (the default)\n" "the group names will appear in their defined order.", FALSE ); //---- cb = cfg->addBool( "SORT_BY_SCOPE_NAME", - "If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be \n" - "sorted by fully-qualified names, including namespaces. If set to \n" - "NO (the default), the class list will be sorted only by class name, \n" - "not including the namespace part. \n" - "Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. \n" - "Note: This option applies only to the class list, not to the \n" + "If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be\n" + "sorted by fully-qualified names, including namespaces. If set to\n" + "NO (the default), the class list will be sorted only by class name,\n" + "not including the namespace part.\n" + "Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\n" + "Note: This option applies only to the class list, not to the\n" "alphabetical list.", FALSE ); //---- cb = cfg->addBool( "GENERATE_TODOLIST", - "The GENERATE_TODOLIST tag can be used to enable (YES) or \n" - "disable (NO) the todo list. This list is created by putting \\todo \n" + "The GENERATE_TODOLIST tag can be used to enable (YES) or\n" + "disable (NO) the todo list. This list is created by putting \\todo\n" "commands in the documentation.", TRUE ); //---- cb = cfg->addBool( "GENERATE_TESTLIST", - "The GENERATE_TESTLIST tag can be used to enable (YES) or \n" - "disable (NO) the test list. This list is created by putting \\test \n" + "The GENERATE_TESTLIST tag can be used to enable (YES) or\n" + "disable (NO) the test list. This list is created by putting \\test\n" "commands in the documentation.", TRUE ); //---- cb = cfg->addBool( "GENERATE_BUGLIST", - "The GENERATE_BUGLIST tag can be used to enable (YES) or \n" - "disable (NO) the bug list. This list is created by putting \\bug \n" + "The GENERATE_BUGLIST tag can be used to enable (YES) or\n" + "disable (NO) the bug list. This list is created by putting \\bug\n" "commands in the documentation.", TRUE ); //---- cb = cfg->addBool( "GENERATE_DEPRECATEDLIST", - "The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or \n" - "disable (NO) the deprecated list. This list is created by putting \n" + "The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or\n" + "disable (NO) the deprecated list. This list is created by putting\n" "\\deprecated commands in the documentation.", TRUE ); //---- cl = cfg->addList( "ENABLED_SECTIONS", - "The ENABLED_SECTIONS tag can be used to enable conditional \n" + "The ENABLED_SECTIONS tag can be used to enable conditional\n" "documentation sections, marked by \\if sectionname ... \\endif." ); //---- ci = cfg->addInt( "MAX_INITIALIZER_LINES", - "The MAX_INITIALIZER_LINES tag determines the maximum number of lines \n" - "the initial value of a variable or define consists of for it to appear in \n" - "the documentation. If the initializer consists of more lines than specified \n" - "here it will be hidden. Use a value of 0 to hide initializers completely. \n" - "The appearance of the initializer of individual variables and defines in the \n" - "documentation can be controlled using \\showinitializer or \\hideinitializer \n" + "The MAX_INITIALIZER_LINES tag determines the maximum number of lines\n" + "the initial value of a variable or define consists of for it to appear in\n" + "the documentation. If the initializer consists of more lines than specified\n" + "here it will be hidden. Use a value of 0 to hide initializers completely.\n" + "The appearance of the initializer of individual variables and defines in the\n" + "documentation can be controlled using \\showinitializer or \\hideinitializer\n" "command in the documentation regardless of this setting.", 0,10000,30 ); //---- cb = cfg->addBool( "SHOW_DIRECTORIES", - "If the sources in your project are distributed over multiple directories \n" - "then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy \n" + "If the sources in your project are distributed over multiple directories\n" + "then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy\n" "in the documentation. The default is NO.", FALSE ); //---- cb = cfg->addBool( "SHOW_FILES", - "Set the SHOW_FILES tag to NO to disable the generation of the Files page. \n" - "This will remove the Files entry from the Quick Index and from the \n" + "Set the SHOW_FILES tag to NO to disable the generation of the Files page.\n" + "This will remove the Files entry from the Quick Index and from the\n" "Folder Tree View (if specified). The default is YES.", TRUE ); //---- cb = cfg->addBool( "SHOW_NAMESPACES", - "Set the SHOW_NAMESPACES tag to NO to disable the generation of the \n" - "Namespaces page. \n" - "This will remove the Namespaces entry from the Quick Index \n" + "Set the SHOW_NAMESPACES tag to NO to disable the generation of the\n" + "Namespaces page.\n" + "This will remove the Namespaces entry from the Quick Index\n" "and from the Folder Tree View (if specified). The default is YES.", TRUE ); //---- cs = cfg->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 \n" - "the 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 program writes to standard output \n" + "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\n" + "the 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 program writes to standard output\n" "is used as the file version. See the manual for examples." ); cs->setWidgetType(ConfigString::File); //---- cs = cfg->addString( "LAYOUT_FILE", - "The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by \n" - "doxygen. The layout file controls the global structure of the generated output files \n" - "in an output format independent way. The create the layout file that represents \n" - "doxygen's defaults, run doxygen with the -l option. You can optionally specify a \n" - "file name after the option, if omitted DoxygenLayout.xml will be used as the name \n" + "The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by\n" + "doxygen. The layout file controls the global structure of the generated output files\n" + "in an output format independent way. The create the layout file that represents\n" + "doxygen's defaults, run doxygen with the -l option. You can optionally specify a\n" + "file name after the option, if omitted DoxygenLayout.xml will be used as the name\n" "of the layout file." ); cs->setWidgetType(ConfigString::File); @@ -683,61 +689,61 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "QUIET", - "The QUIET tag can be used to turn on/off the messages that are generated \n" + "The QUIET tag can be used to turn on/off the messages that are generated\n" "by doxygen. Possible values are YES and NO. If left blank NO is used.", FALSE ); //---- cb = cfg->addBool( "WARNINGS", - "The WARNINGS tag can be used to turn on/off the warning messages that are \n" - "generated by doxygen. Possible values are YES and NO. If left blank \n" + "The WARNINGS tag can be used to turn on/off the warning messages that are\n" + "generated by doxygen. Possible values are YES and NO. If left blank\n" "NO is used.", TRUE ); //---- cb = cfg->addBool( "WARN_IF_UNDOCUMENTED", - "If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings \n" - "for undocumented members. If EXTRACT_ALL is set to YES then this flag will \n" + "If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings\n" + "for undocumented members. If EXTRACT_ALL is set to YES then this flag will\n" "automatically be disabled.", TRUE ); //---- cb = cfg->addBool( "WARN_IF_DOC_ERROR", - "If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for \n" - "potential errors in the documentation, such as not documenting some \n" - "parameters in a documented function, or documenting parameters that \n" + "If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for\n" + "potential errors in the documentation, such as not documenting some\n" + "parameters in a documented function, or documenting parameters that\n" "don't exist or using markup commands wrongly.", TRUE ); //---- cb = cfg->addBool( "WARN_NO_PARAMDOC", - "This WARN_NO_PARAMDOC option can be abled to get warnings for \n" - "functions that are documented, but have no documentation for their parameters \n" - "or return value. If set to NO (the default) doxygen will only warn about \n" - "wrong or incomplete parameter documentation, but not about the absence of \n" + "This WARN_NO_PARAMDOC option can be abled to get warnings for\n" + "functions that are documented, but have no documentation for their parameters\n" + "or return value. If set to NO (the default) doxygen will only warn about\n" + "wrong or incomplete parameter documentation, but not about the absence of\n" "documentation.", FALSE ); //---- cs = cfg->addString( "WARN_FORMAT", - "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. Optionally the format may contain \n" - "$version, which will be replaced by the version of the file (if it could \n" + "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. 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)" ); cs->setDefaultValue("$file:$line: $text"); //---- cs = cfg->addString( "WARN_LOGFILE", - "The WARN_LOGFILE tag can be used to specify a file to which warning \n" - "and error messages should be written. If left blank the output is written \n" + "The WARN_LOGFILE tag can be used to specify a file to which warning\n" + "and error messages should be written. If left blank the output is written\n" "to stderr." ); cs->setWidgetType(ConfigString::File); @@ -748,9 +754,9 @@ void addConfigOptions(Config *cfg) //---- cl = cfg->addList( "INPUT", - "The INPUT tag can be used to specify the files and/or directories that contain \n" - "documented source files. You may enter file names like \"myfile.cpp\" or \n" - "directories like \"/usr/src/myproject\". Separate the files or directories \n" + "The INPUT tag can be used to specify the files and/or directories that contain\n" + "documented source files. You may enter file names like \"myfile.cpp\" or\n" + "directories like \"/usr/src/myproject\". Separate the files or directories\n" "with spaces." ); cl->addValue("/Users/dimitri/doxygen/mail/1.5.7/doxywizard"); @@ -758,21 +764,21 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "INPUT_ENCODING", - "This tag can be used to specify the character encoding of the source files \n" - "that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is \n" - "also the default input encoding. Doxygen uses libiconv (or the iconv built \n" - "into libc) for the transcoding. See http://www.gnu.org/software/libiconv for \n" + "This tag can be used to specify the character encoding of the source files\n" + "that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is\n" + "also the default input encoding. Doxygen uses libiconv (or the iconv built\n" + "into libc) for the transcoding. See http://www.gnu.org/software/libiconv for\n" "the list of possible encodings." ); cs->setDefaultValue("UTF-8"); //---- cl = cfg->addList( "FILE_PATTERNS", - "If the value of the INPUT tag contains directories, you can use the \n" - "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 \n" + "If the value of the INPUT tag contains directories, you can use the\n" + "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\n" "*.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90" ); cl->addValue("*.c"); @@ -809,110 +815,110 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "RECURSIVE", - "The RECURSIVE tag can be used to turn specify whether or not subdirectories \n" - "should be searched for input files as well. Possible values are YES and NO. \n" + "The RECURSIVE tag can be used to turn specify whether or not subdirectories\n" + "should be searched for input files as well. Possible values are YES and NO.\n" "If left blank NO is used.", FALSE ); //---- cl = cfg->addList( "EXCLUDE", - "The EXCLUDE tag can be used to specify files and/or directories that should \n" - "excluded from the INPUT source files. This way you can easily exclude a \n" + "The EXCLUDE tag can be used to specify files and/or directories that should\n" + "excluded from the INPUT source files. This way you can easily exclude a\n" "subdirectory from a directory tree whose root is specified with the INPUT tag." ); cl->setWidgetType(ConfigList::FileAndDir); //---- cb = cfg->addBool( "EXCLUDE_SYMLINKS", - "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" + "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.", FALSE ); //---- cl = cfg->addList( "EXCLUDE_PATTERNS", - "If the value of the INPUT tag contains directories, you can use the \n" - "EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude \n" - "certain files from those directories. Note that the wildcards are matched \n" - "against the file with absolute path, so to exclude all test directories \n" + "If the value of the INPUT tag contains directories, you can use the\n" + "EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude\n" + "certain files from those directories. Note that the wildcards are matched\n" + "against the file with absolute path, so to exclude all test directories\n" "for example use the pattern */test/*" ); //---- cl = cfg->addList( "EXCLUDE_SYMBOLS", - "The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names \n" - "(namespaces, classes, functions, etc.) that should be excluded from the \n" - "output. The symbol name can be a fully qualified name, a word, or if the \n" - "wildcard * is used, a substring. Examples: ANamespace, AClass, \n" + "The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names\n" + "(namespaces, classes, functions, etc.) that should be excluded from the\n" + "output. The symbol name can be a fully qualified name, a word, or if the\n" + "wildcard * is used, a substring. Examples: ANamespace, AClass,\n" "AClass::ANamespace, ANamespace::*Test" ); //---- cl = cfg->addList( "EXAMPLE_PATH", - "The EXAMPLE_PATH tag can be used to specify one or more files or \n" - "directories that contain example code fragments that are included (see \n" + "The EXAMPLE_PATH tag can be used to specify one or more files or\n" + "directories that contain example code fragments that are included (see\n" "the \\include command)." ); cl->setWidgetType(ConfigList::Dir); //---- cl = cfg->addList( "EXAMPLE_PATTERNS", - "If the value of the EXAMPLE_PATH tag contains directories, you can use the \n" - "EXAMPLE_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" + "If the value of the EXAMPLE_PATH tag contains directories, you can use the\n" + "EXAMPLE_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 all files are included." ); cl->addValue("*"); //---- cb = cfg->addBool( "EXAMPLE_RECURSIVE", - "If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be \n" - "searched for input files to be used with the \\include or \\dontinclude \n" - "commands irrespective of the value of the RECURSIVE tag. \n" + "If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\n" + "searched for input files to be used with the \\include or \\dontinclude\n" + "commands irrespective of the value of the RECURSIVE tag.\n" "Possible values are YES and NO. If left blank NO is used.", FALSE ); //---- cl = cfg->addList( "IMAGE_PATH", - "The IMAGE_PATH tag can be used to specify one or more files or \n" - "directories that contain image that are included in the documentation (see \n" + "The IMAGE_PATH tag can be used to specify one or more files or\n" + "directories that contain image that are included in the documentation (see\n" "the \\image command)." ); cl->setWidgetType(ConfigList::Dir); //---- cs = cfg->addString( "INPUT_FILTER", - "The INPUT_FILTER tag can be used to specify a program that doxygen should \n" - "invoke to filter for each input file. Doxygen will invoke the filter program \n" - "by executing (via popen()) the command <filter> <input-file>, where <filter> \n" - "is the value of the INPUT_FILTER tag, and <input-file> is the name of an \n" - "input file. Doxygen will then use the output that the filter program writes \n" - "to standard output. \n" - "If FILTER_PATTERNS is specified, this tag will be \n" + "The INPUT_FILTER tag can be used to specify a program that doxygen should\n" + "invoke to filter for each input file. Doxygen will invoke the filter program\n" + "by executing (via popen()) the command <filter> <input-file>, where <filter>\n" + "is the value of the INPUT_FILTER tag, and <input-file> is the name of an\n" + "input file. Doxygen will then use the output that the filter program writes\n" + "to standard output.\n" + "If FILTER_PATTERNS is specified, this tag will be\n" "ignored." ); cs->setWidgetType(ConfigString::File); //---- cl = cfg->addList( "FILTER_PATTERNS", - "The FILTER_PATTERNS tag can be used to specify filters on a per file pattern \n" - "basis. \n" - "Doxygen will compare the file name with each pattern and apply the \n" - "filter if there is a match. \n" - "The filters are a list of the form: \n" - "pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further \n" - "info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER \n" + "The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\n" + "basis.\n" + "Doxygen will compare the file name with each pattern and apply the\n" + "filter if there is a match.\n" + "The filters are a list of the form:\n" + "pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further\n" + "info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER\n" "is applied to all files." ); cl->setWidgetType(ConfigList::File); //---- cb = cfg->addBool( "FILTER_SOURCE_FILES", - "If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using \n" - "INPUT_FILTER) will be used to filter the input files when producing source \n" + "If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\n" + "INPUT_FILTER) will be used to filter the input files when producing source\n" "files to browse (i.e. when SOURCE_BROWSER is set to YES).", FALSE ); @@ -923,60 +929,60 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "SOURCE_BROWSER", - "If the SOURCE_BROWSER tag is set to YES then a list of source files will \n" - "be generated. Documented entities will be cross-referenced with these sources. \n" - "Note: To get rid of all source code in the generated output, make sure also \n" + "If the SOURCE_BROWSER tag is set to YES then a list of source files will\n" + "be generated. Documented entities will be cross-referenced with these sources.\n" + "Note: To get rid of all source code in the generated output, make sure also\n" "VERBATIM_HEADERS is set to NO.", FALSE ); //---- cb = cfg->addBool( "INLINE_SOURCES", - "Setting the INLINE_SOURCES tag to YES will include the body \n" + "Setting the INLINE_SOURCES tag to YES will include the body\n" "of functions and classes directly in the documentation.", FALSE ); //---- cb = cfg->addBool( "STRIP_CODE_COMMENTS", - "Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct \n" - "doxygen to hide any special comment blocks from generated source code \n" + "Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct\n" + "doxygen to hide any special comment blocks from generated source code\n" "fragments. Normal C and C++ comments will always remain visible.", TRUE ); //---- cb = cfg->addBool( "REFERENCED_BY_RELATION", - "If the REFERENCED_BY_RELATION tag is set to YES \n" - "then for each documented function all documented \n" + "If the REFERENCED_BY_RELATION tag is set to YES\n" + "then for each documented function all documented\n" "functions referencing it will be listed.", FALSE ); //---- cb = cfg->addBool( "REFERENCES_RELATION", - "If the REFERENCES_RELATION tag is set to YES \n" - "then for each documented function all documented entities \n" + "If the REFERENCES_RELATION tag is set to YES\n" + "then for each documented function all documented entities\n" "called/used by that function will be listed.", FALSE ); //---- cb = cfg->addBool( "REFERENCES_LINK_SOURCE", - "If the REFERENCES_LINK_SOURCE tag is set to YES (the default) \n" - "and SOURCE_BROWSER tag is set to YES, then the hyperlinks from \n" - "functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will \n" - "link to the source code. \n" + "If the REFERENCES_LINK_SOURCE tag is set to YES (the default)\n" + "and SOURCE_BROWSER tag is set to YES, then the hyperlinks from\n" + "functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will\n" + "link to the source code.\n" "Otherwise they will link to the documentation.", TRUE ); //---- cb = cfg->addBool( "USE_HTAGS", - "If the USE_HTAGS tag is set to YES then the references to source code \n" - "will point to the HTML generated by the htags(1) tool instead of doxygen \n" - "built-in source browser. The htags tool is part of GNU's global source \n" - "tagging system (see http://www.gnu.org/software/global/global.html). You \n" + "If the USE_HTAGS tag is set to YES then the references to source code\n" + "will point to the HTML generated by the htags(1) tool instead of doxygen\n" + "built-in source browser. The htags tool is part of GNU's global source\n" + "tagging system (see http://www.gnu.org/software/global/global.html). You\n" "will need version 4.8.6 or higher.", FALSE ); @@ -984,8 +990,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "VERBATIM_HEADERS", - "If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen \n" - "will generate a verbatim copy of the header file for each class for \n" + "If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen\n" + "will generate a verbatim copy of the header file for each class for\n" "which an include is specified. Set to NO to disable this.", TRUE ); @@ -996,25 +1002,25 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "ALPHABETICAL_INDEX", - "If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index \n" - "of all compounds will be generated. Enable this if the project \n" + "If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index\n" + "of all compounds will be generated. Enable this if the project\n" "contains a lot of classes, structs, unions or interfaces.", FALSE ); //---- ci = cfg->addInt( "COLS_IN_ALPHA_INDEX", - "If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then \n" - "the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns \n" + "If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then\n" + "the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns\n" "in which this list will be split (can be a number in the range [1..20])", 1,20,5 ); //---- cl = cfg->addList( "IGNORE_PREFIX", - "In case all classes in a project start with a common prefix, all \n" - "classes will be put under the same header in the alphabetical index. \n" - "The IGNORE_PREFIX tag can be used to specify one or more prefixes that \n" + "In case all classes in a project start with a common prefix, all\n" + "classes will be put under the same header in the alphabetical index.\n" + "The IGNORE_PREFIX tag can be used to specify one or more prefixes that\n" "should be ignored while generating the index headers." ); //--------------------------------------------------------------------------- @@ -1024,15 +1030,15 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_HTML", - "If the GENERATE_HTML tag is set to YES (the default) Doxygen will \n" + "If the GENERATE_HTML tag is set to YES (the default) Doxygen will\n" "generate HTML output.", TRUE ); //---- cs = cfg->addString( "HTML_OUTPUT", - "The HTML_OUTPUT tag is used to specify where the HTML docs will be put. \n" - "If a relative path is entered the value of OUTPUT_DIRECTORY will be \n" + "The HTML_OUTPUT tag is used to specify where the HTML docs will be put.\n" + "If a relative path is entered the value of OUTPUT_DIRECTORY will be\n" "put in front of it. If left blank `html' will be used as the default path." ); cs->setDefaultValue("html"); @@ -1041,8 +1047,8 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "HTML_FILE_EXTENSION", - "The HTML_FILE_EXTENSION tag can be used to specify the file extension for \n" - "each generated HTML page (for example: .htm,.php,.asp). If it is left blank \n" + "The HTML_FILE_EXTENSION tag can be used to specify the file extension for\n" + "each generated HTML page (for example: .htm,.php,.asp). If it is left blank\n" "doxygen will generate files with .html extension." ); cs->setDefaultValue(".html"); @@ -1050,8 +1056,8 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "HTML_HEADER", - "The HTML_HEADER tag can be used to specify a personal HTML header for \n" - "each generated HTML page. If it is left blank doxygen will generate a \n" + "The HTML_HEADER tag can be used to specify a personal HTML header for\n" + "each generated HTML page. If it is left blank doxygen will generate a\n" "standard header." ); cs->setWidgetType(ConfigString::File); @@ -1059,8 +1065,8 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "HTML_FOOTER", - "The HTML_FOOTER tag can be used to specify a personal HTML footer for \n" - "each generated HTML page. If it is left blank doxygen will generate a \n" + "The HTML_FOOTER tag can be used to specify a personal HTML footer for\n" + "each generated HTML page. If it is left blank doxygen will generate a\n" "standard footer." ); cs->setWidgetType(ConfigString::File); @@ -1068,11 +1074,11 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "HTML_STYLESHEET", - "The HTML_STYLESHEET tag can be used to specify a user-defined cascading \n" - "style sheet that is used by each HTML page. It can be used to \n" - "fine-tune the look of the HTML output. If the tag is left blank doxygen \n" - "will generate a default style sheet. Note that doxygen will try to copy \n" - "the style sheet file to the HTML output directory, so don't put your own \n" + "The HTML_STYLESHEET tag can be used to specify a user-defined cascading\n" + "style sheet that is used by each HTML page. It can be used to\n" + "fine-tune the look of the HTML output. If the tag is left blank doxygen\n" + "will generate a default style sheet. Note that doxygen will try to copy\n" + "the style sheet file to the HTML output directory, so don't put your own\n" "stylesheet in the HTML output directory as well, or it will be erased!" ); cs->setWidgetType(ConfigString::File); @@ -1080,8 +1086,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "HTML_ALIGN_MEMBERS", - "If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, \n" - "files or namespaces will be aligned in HTML using tables. If set to \n" + "If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,\n" + "files or namespaces will be aligned in HTML using tables. If set to\n" "NO a bullet list will be used.", TRUE ); @@ -1089,10 +1095,10 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "HTML_DYNAMIC_SECTIONS", - "If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML \n" - "documentation will contain sections that can be hidden and shown after the \n" - "page has loaded. For this to work a browser that supports \n" - "JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox \n" + "If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\n" + "documentation will contain sections that can be hidden and shown after the\n" + "page has loaded. For this to work a browser that supports\n" + "JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox\n" "Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).", FALSE ); @@ -1100,14 +1106,14 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_DOCSET", - "If the GENERATE_DOCSET tag is set to YES, additional index files \n" - "will be generated that can be used as input for Apple's Xcode 3 \n" - "integrated development environment, introduced with OSX 10.5 (Leopard). \n" - "To create a documentation set, doxygen will generate a Makefile in the \n" - "HTML output directory. Running make will produce the docset in that \n" - "directory and running \"make install\" will install the docset in \n" - "~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find \n" - "it at startup. \n" + "If the GENERATE_DOCSET tag is set to YES, additional index files\n" + "will be generated that can be used as input for Apple's Xcode 3\n" + "integrated development environment, introduced with OSX 10.5 (Leopard).\n" + "To create a documentation set, doxygen will generate a Makefile in the\n" + "HTML output directory. Running make will produce the docset in that\n" + "directory and running \"make install\" will install the docset in\n" + "~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find\n" + "it at startup.\n" "See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.", FALSE ); @@ -1115,9 +1121,9 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "DOCSET_FEEDNAME", - "When GENERATE_DOCSET tag is set to YES, this tag determines the name of the \n" - "feed. A documentation feed provides an umbrella under which multiple \n" - "documentation sets from a single provider (such as a company or product suite) \n" + "When GENERATE_DOCSET tag is set to YES, this tag determines the name of the\n" + "feed. A documentation feed provides an umbrella under which multiple\n" + "documentation sets from a single provider (such as a company or product suite)\n" "can be grouped." ); cs->setDefaultValue("Doxygen generated docs"); @@ -1125,9 +1131,9 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "DOCSET_BUNDLE_ID", - "When GENERATE_DOCSET tag is set to YES, this tag specifies a string that \n" - "should uniquely identify the documentation set bundle. This should be a \n" - "reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen \n" + "When GENERATE_DOCSET tag is set to YES, this tag specifies a string that\n" + "should uniquely identify the documentation set bundle. This should be a\n" + "reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen\n" "will append .docset to the name." ); cs->setDefaultValue("org.doxygen.Project"); @@ -1135,9 +1141,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_HTMLHELP", - "If the GENERATE_HTMLHELP tag is set to YES, additional index files \n" - "will be generated that can be used as input for tools like the \n" - "Microsoft HTML help workshop to generate a compiled HTML help file (.chm) \n" + "If the GENERATE_HTMLHELP tag is set to YES, additional index files\n" + "will be generated that can be used as input for tools like the\n" + "Microsoft HTML help workshop to generate a compiled HTML help file (.chm)\n" "of the generated HTML documentation.", FALSE ); @@ -1145,9 +1151,9 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "CHM_FILE", - "If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can \n" - "be used to specify the file name of the resulting .chm file. You \n" - "can add a path in front of the file if the result should not be \n" + "If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can\n" + "be used to specify the file name of the resulting .chm file. You\n" + "can add a path in front of the file if the result should not be\n" "written to the html output directory." ); cs->setWidgetType(ConfigString::File); @@ -1155,9 +1161,9 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "HHC_LOCATION", - "If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can \n" - "be used to specify the location (absolute path including file name) of \n" - "the HTML help compiler (hhc.exe). If non-empty doxygen will try to run \n" + "If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can\n" + "be used to specify the location (absolute path including file name) of\n" + "the HTML help compiler (hhc.exe). If non-empty doxygen will try to run\n" "the HTML help compiler on the generated index.hhp." ); cs->setWidgetType(ConfigString::File); @@ -1165,8 +1171,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_CHI", - "If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag \n" - "controls if a separate .chi index file is generated (YES) or that \n" + "If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag\n" + "controls if a separate .chi index file is generated (YES) or that\n" "it should be included in the master .chm file (NO).", FALSE ); @@ -1174,16 +1180,16 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "CHM_INDEX_ENCODING", - "If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING \n" - "is used to encode HtmlHelp index (hhk), content (hhc) and project file \n" + "If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING\n" + "is used to encode HtmlHelp index (hhk), content (hhc) and project file\n" "content." ); cs->addDependency("GENERATE_HTMLHELP"); //---- cb = cfg->addBool( "BINARY_TOC", - "If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag \n" - "controls whether a binary table of contents is generated (YES) or a \n" + "If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag\n" + "controls whether a binary table of contents is generated (YES) or a\n" "normal table of contents (NO) in the .chm file.", FALSE ); @@ -1191,7 +1197,7 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "TOC_EXPAND", - "The TOC_EXPAND flag can be set to YES to add extra items for group members \n" + "The TOC_EXPAND flag can be set to YES to add extra items for group members\n" "to the contents of the HTML help documentation and to the tree view.", FALSE ); @@ -1199,9 +1205,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_QHP", - "If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER \n" - "are set, an additional index file will be generated that can be used as input for \n" - "Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated \n" + "If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER\n" + "are set, an additional index file will be generated that can be used as input for\n" + "Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated\n" "HTML documentation.", FALSE ); @@ -1209,8 +1215,8 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "QCH_FILE", - "If the QHG_LOCATION tag is specified, the QCH_FILE tag can \n" - "be used to specify the file name of the resulting .qch file. \n" + "If the QHG_LOCATION tag is specified, the QCH_FILE tag can\n" + "be used to specify the file name of the resulting .qch file.\n" "The path specified is relative to the HTML output folder." ); cs->setWidgetType(ConfigString::File); @@ -1218,16 +1224,16 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "QHP_NAMESPACE", - "The QHP_NAMESPACE tag specifies the namespace to use when generating \n" - "Qt Help Project output. For more information please see \n" + "The QHP_NAMESPACE tag specifies the namespace to use when generating\n" + "Qt Help Project output. For more information please see\n" "http://doc.trolltech.com/qthelpproject.html#namespace" ); cs->addDependency("GENERATE_QHP"); //---- cs = cfg->addString( "QHP_VIRTUAL_FOLDER", - "The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating \n" - "Qt Help Project output. For more information please see \n" + "The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating\n" + "Qt Help Project output. For more information please see\n" "http://doc.trolltech.com/qthelpproject.html#virtual-folders" ); cs->setDefaultValue("doc"); @@ -1235,32 +1241,32 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "QHP_CUST_FILTER_NAME", - "If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. \n" - "For more information please see \n" + "If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.\n" + "For more information please see\n" "http://doc.trolltech.com/qthelpproject.html#custom-filters" ); cs->addDependency("GENERATE_QHP"); //---- cs = cfg->addString( "QHP_CUST_FILTER_ATTRS", - "The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see \n" + "The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see\n" "<a href=\"http://doc.trolltech.com/qthelpproject.html#custom-filters\">Qt Help Project / Custom Filters</a>." ); cs->addDependency("GENERATE_QHP"); //---- cs = cfg->addString( "QHP_SECT_FILTER_ATTRS", - "The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's \n" - "filter section matches. \n" + "The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's\n" + "filter section matches.\n" "<a href=\"http://doc.trolltech.com/qthelpproject.html#filter-attributes\">Qt Help Project / Filter Attributes</a>." ); cs->addDependency("GENERATE_QHP"); //---- cs = cfg->addString( "QHG_LOCATION", - "If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can \n" - "be used to specify the location of Qt's qhelpgenerator. \n" - "If non-empty doxygen will try to run qhelpgenerator on the generated \n" + "If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can\n" + "be used to specify the location of Qt's qhelpgenerator.\n" + "If non-empty doxygen will try to run qhelpgenerator on the generated\n" ".qhp file." ); cs->setWidgetType(ConfigString::File); @@ -1268,8 +1274,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "DISABLE_INDEX", - "The DISABLE_INDEX tag can be used to turn on/off the condensed index at \n" - "top of each HTML page. The value NO (the default) enables the index and \n" + "The DISABLE_INDEX tag can be used to turn on/off the condensed index at\n" + "top of each HTML page. The value NO (the default) enables the index and\n" "the value YES disables it.", FALSE ); @@ -1277,7 +1283,7 @@ void addConfigOptions(Config *cfg) //---- ci = cfg->addInt( "ENUM_VALUES_PER_LINE", - "This tag can be used to set the number of enum values (range [1..20]) \n" + "This tag can be used to set the number of enum values (range [1..20])\n" "that doxygen will group on one line in the generated HTML documentation.", 1,20,4 ); @@ -1285,12 +1291,12 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_TREEVIEW", - "The GENERATE_TREEVIEW tag is used to specify whether a tree-like index \n" - "structure should be generated to display hierarchical information. \n" - "If the tag value is set to FRAME, a side panel will be generated \n" - "containing a tree-like index structure (just like the one that \n" - "is generated for HTML Help). For this to work a browser that supports \n" - "JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). \n" + "The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\n" + "structure should be generated to display hierarchical information.\n" + "If the tag value is set to FRAME, a side panel will be generated\n" + "containing a tree-like index structure (just like the one that\n" + "is generated for HTML Help). For this to work a browser that supports\n" + "JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).\n" "Windows users are probably better off using the HTML help feature.", FALSE ); @@ -1298,7 +1304,7 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "USE_INLINE_TREES", - "By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, \n" + "By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,\n" "and Class Hierarchy pages using a tree view instead of an ordered list.", FALSE ); @@ -1306,8 +1312,8 @@ void addConfigOptions(Config *cfg) //---- ci = cfg->addInt( "TREEVIEW_WIDTH", - "If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be \n" - "used to set the initial width (in pixels) of the frame in which the tree \n" + "If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be\n" + "used to set the initial width (in pixels) of the frame in which the tree\n" "is shown.", 0,1500,250 ); @@ -1315,10 +1321,10 @@ void addConfigOptions(Config *cfg) //---- ci = cfg->addInt( "FORMULA_FONTSIZE", - "Use this tag to change the font size of Latex formulas included \n" - "as images in the HTML documentation. The default is 10. Note that \n" - "when you change the font size after a successful doxygen run you need \n" - "to manually remove any form_*.png images from the HTML output directory \n" + "Use this tag to change the font size of Latex formulas included\n" + "as images in the HTML documentation. The default is 10. Note that\n" + "when you change the font size after a successful doxygen run you need\n" + "to manually remove any form_*.png images from the HTML output directory\n" "to force them to be regenerated.", 8,50,10 ); @@ -1326,9 +1332,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "SEARCHENGINE", - "When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript \n" - "and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) \n" - "there is already a search function so this one should typically \n" + "When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript\n" + "and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)\n" + "there is already a search function so this one should typically\n" "be disabled.", TRUE ); @@ -1340,15 +1346,15 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_LATEX", - "If the GENERATE_LATEX tag is set to YES (the default) Doxygen will \n" + "If the GENERATE_LATEX tag is set to YES (the default) Doxygen will\n" "generate Latex output.", TRUE ); //---- cs = cfg->addString( "LATEX_OUTPUT", - "The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. \n" - "If a relative path is entered the value of OUTPUT_DIRECTORY will be \n" + "The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.\n" + "If a relative path is entered the value of OUTPUT_DIRECTORY will be\n" "put in front of it. If left blank `latex' will be used as the default path." ); cs->setDefaultValue("latex"); @@ -1357,7 +1363,7 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "LATEX_CMD_NAME", - "The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be \n" + "The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be\n" "invoked. If left blank `latex' will be used as the default command name." ); cs->setDefaultValue("latex"); @@ -1366,8 +1372,8 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "MAKEINDEX_CMD_NAME", - "The MAKEINDEX_CMD_NAME tag can be used to specify the command name to \n" - "generate index for LaTeX. If left blank `makeindex' will be used as the \n" + "The MAKEINDEX_CMD_NAME tag can be used to specify the command name to\n" + "generate index for LaTeX. If left blank `makeindex' will be used as the\n" "default command name." ); cs->setDefaultValue("makeindex"); @@ -1376,8 +1382,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "COMPACT_LATEX", - "If the COMPACT_LATEX tag is set to YES Doxygen generates more compact \n" - "LaTeX documents. This may be useful for small projects and may help to \n" + "If the COMPACT_LATEX tag is set to YES Doxygen generates more compact\n" + "LaTeX documents. This may be useful for small projects and may help to\n" "save some trees in general.", FALSE ); @@ -1385,8 +1391,8 @@ void addConfigOptions(Config *cfg) //---- ce = cfg->addEnum( "PAPER_TYPE", - "The PAPER_TYPE tag can be used to set the paper type that is used \n" - "by the printer. Possible values are: a4, a4wide, letter, legal and \n" + "The PAPER_TYPE tag can be used to set the paper type that is used\n" + "by the printer. Possible values are: a4, a4wide, letter, legal and\n" "executive. If left blank a4wide will be used.", "a4wide" ); @@ -1399,16 +1405,16 @@ void addConfigOptions(Config *cfg) //---- cl = cfg->addList( "EXTRA_PACKAGES", - "The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX \n" + "The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX\n" "packages that should be included in the LaTeX output." ); cl->addDependency("GENERATE_LATEX"); //---- cs = cfg->addString( "LATEX_HEADER", - "The LATEX_HEADER tag can be used to specify a personal LaTeX header for \n" - "the generated latex document. The header should contain everything until \n" - "the first chapter. If it is left blank doxygen will generate a \n" + "The LATEX_HEADER tag can be used to specify a personal LaTeX header for\n" + "the generated latex document. The header should contain everything until\n" + "the first chapter. If it is left blank doxygen will generate a\n" "standard header. Notice: only use this tag if you know what you are doing!" ); cs->setWidgetType(ConfigString::File); @@ -1416,9 +1422,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "PDF_HYPERLINKS", - "If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated \n" - "is prepared for conversion to pdf (using ps2pdf). The pdf file will \n" - "contain links (just like the HTML output) instead of page references \n" + "If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated\n" + "is prepared for conversion to pdf (using ps2pdf). The pdf file will\n" + "contain links (just like the HTML output) instead of page references\n" "This makes the output suitable for online browsing using a pdf viewer.", TRUE ); @@ -1426,8 +1432,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "USE_PDFLATEX", - "If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of \n" - "plain latex in the generated Makefile. Set this option to YES to get a \n" + "If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of\n" + "plain latex in the generated Makefile. Set this option to YES to get a\n" "higher quality PDF documentation.", TRUE ); @@ -1435,9 +1441,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "LATEX_BATCHMODE", - "If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\\\batchmode. \n" - "command to the generated LaTeX files. This will instruct LaTeX to keep \n" - "running if errors occur, instead of asking the user for help. \n" + "If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\\\batchmode.\n" + "command to the generated LaTeX files. This will instruct LaTeX to keep\n" + "running if errors occur, instead of asking the user for help.\n" "This option is also used when generating formulas in HTML.", FALSE ); @@ -1445,8 +1451,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "LATEX_HIDE_INDICES", - "If LATEX_HIDE_INDICES is set to YES then doxygen will not \n" - "include the index chapters (such as File Index, Compound Index, etc.) \n" + "If LATEX_HIDE_INDICES is set to YES then doxygen will not\n" + "include the index chapters (such as File Index, Compound Index, etc.)\n" "in the output.", FALSE ); @@ -1465,16 +1471,16 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_RTF", - "If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output \n" - "The RTF output is optimized for Word 97 and may not look very pretty with \n" + "If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output\n" + "The RTF output is optimized for Word 97 and may not look very pretty with\n" "other RTF readers or editors.", FALSE ); //---- cs = cfg->addString( "RTF_OUTPUT", - "The RTF_OUTPUT tag is used to specify where the RTF docs will be put. \n" - "If a relative path is entered the value of OUTPUT_DIRECTORY will be \n" + "The RTF_OUTPUT tag is used to specify where the RTF docs will be put.\n" + "If a relative path is entered the value of OUTPUT_DIRECTORY will be\n" "put in front of it. If left blank `rtf' will be used as the default path." ); cs->setDefaultValue("rtf"); @@ -1483,8 +1489,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "COMPACT_RTF", - "If the COMPACT_RTF tag is set to YES Doxygen generates more compact \n" - "RTF documents. This may be useful for small projects and may help to \n" + "If the COMPACT_RTF tag is set to YES Doxygen generates more compact\n" + "RTF documents. This may be useful for small projects and may help to\n" "save some trees in general.", FALSE ); @@ -1492,11 +1498,11 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "RTF_HYPERLINKS", - "If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated \n" - "will contain hyperlink fields. The RTF file will \n" - "contain links (just like the HTML output) instead of page references. \n" - "This makes the output suitable for online browsing using WORD or other \n" - "programs which support those fields. \n" + "If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated\n" + "will contain hyperlink fields. The RTF file will\n" + "contain links (just like the HTML output) instead of page references.\n" + "This makes the output suitable for online browsing using WORD or other\n" + "programs which support those fields.\n" "Note: wordpad (write) and others do not support links.", FALSE ); @@ -1504,8 +1510,8 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "RTF_STYLESHEET_FILE", - "Load stylesheet definitions from file. Syntax is similar to doxygen's \n" - "config file, i.e. a series of assignments. You only have to provide \n" + "Load stylesheet definitions from file. Syntax is similar to doxygen's\n" + "config file, i.e. a series of assignments. You only have to provide\n" "replacements, missing definitions are set to their default value." ); cs->setWidgetType(ConfigString::File); @@ -1513,7 +1519,7 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "RTF_EXTENSIONS_FILE", - "Set optional variables used in the generation of an rtf document. \n" + "Set optional variables used in the generation of an rtf document.\n" "Syntax is similar to doxygen's config file." ); cs->setWidgetType(ConfigString::File); @@ -1525,15 +1531,15 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_MAN", - "If the GENERATE_MAN tag is set to YES (the default) Doxygen will \n" + "If the GENERATE_MAN tag is set to YES (the default) Doxygen will\n" "generate man pages", FALSE ); //---- cs = cfg->addString( "MAN_OUTPUT", - "The MAN_OUTPUT tag is used to specify where the man pages will be put. \n" - "If a relative path is entered the value of OUTPUT_DIRECTORY will be \n" + "The MAN_OUTPUT tag is used to specify where the man pages will be put.\n" + "If a relative path is entered the value of OUTPUT_DIRECTORY will be\n" "put in front of it. If left blank `man' will be used as the default path." ); cs->setDefaultValue("man"); @@ -1542,7 +1548,7 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "MAN_EXTENSION", - "The MAN_EXTENSION tag determines the extension that is added to \n" + "The MAN_EXTENSION tag determines the extension that is added to\n" "the generated man pages (default is the subroutine's section .3)" ); cs->setDefaultValue(".3"); @@ -1550,10 +1556,10 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "MAN_LINKS", - "If the MAN_LINKS tag is set to YES and Doxygen generates man output, \n" - "then it will generate one additional man file for each entity \n" - "documented in the real man page(s). These additional files \n" - "only source the real man page, but without them the man command \n" + "If the MAN_LINKS tag is set to YES and Doxygen generates man output,\n" + "then it will generate one additional man file for each entity\n" + "documented in the real man page(s). These additional files\n" + "only source the real man page, but without them the man command\n" "would be unable to find the correct page. The default is NO.", FALSE ); @@ -1565,16 +1571,16 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_XML", - "If the GENERATE_XML tag is set to YES Doxygen will \n" - "generate an XML file that captures the structure of \n" + "If the GENERATE_XML tag is set to YES Doxygen will\n" + "generate an XML file that captures the structure of\n" "the code including all documentation.", FALSE ); //---- cs = cfg->addString( "XML_OUTPUT", - "The XML_OUTPUT tag is used to specify where the XML pages will be put. \n" - "If a relative path is entered the value of OUTPUT_DIRECTORY will be \n" + "The XML_OUTPUT tag is used to specify where the XML pages will be put.\n" + "If a relative path is entered the value of OUTPUT_DIRECTORY will be\n" "put in front of it. If left blank `xml' will be used as the default path." ); cs->setDefaultValue("xml"); @@ -1583,25 +1589,25 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "XML_SCHEMA", - "The XML_SCHEMA tag can be used to specify an XML schema, \n" - "which can be used by a validating XML parser to check the \n" + "The XML_SCHEMA tag can be used to specify an XML schema,\n" + "which can be used by a validating XML parser to check the\n" "syntax of the XML files." ); cs->addDependency("GENERATE_XML"); //---- cs = cfg->addString( "XML_DTD", - "The XML_DTD tag can be used to specify an XML DTD, \n" - "which can be used by a validating XML parser to check the \n" + "The XML_DTD tag can be used to specify an XML DTD,\n" + "which can be used by a validating XML parser to check the\n" "syntax of the XML files." ); cs->addDependency("GENERATE_XML"); //---- cb = cfg->addBool( "XML_PROGRAMLISTING", - "If the XML_PROGRAMLISTING tag is set to YES Doxygen will \n" - "dump the program listings (including syntax highlighting \n" - "and cross-referencing information) to the XML output. Note that \n" + "If the XML_PROGRAMLISTING tag is set to YES Doxygen will\n" + "dump the program listings (including syntax highlighting\n" + "and cross-referencing information) to the XML output. Note that\n" "enabling this will significantly increase the size of the XML output.", TRUE ); @@ -1613,10 +1619,10 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_AUTOGEN_DEF", - "If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will \n" - "generate an AutoGen Definitions (see autogen.sf.net) file \n" - "that captures the structure of the code including all \n" - "documentation. Note that this feature is still experimental \n" + "If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will\n" + "generate an AutoGen Definitions (see autogen.sf.net) file\n" + "that captures the structure of the code including all\n" + "documentation. Note that this feature is still experimental\n" "and incomplete at the moment.", FALSE ); @@ -1627,18 +1633,18 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GENERATE_PERLMOD", - "If the GENERATE_PERLMOD tag is set to YES Doxygen will \n" - "generate a Perl module file that captures the structure of \n" - "the code including all documentation. Note that this \n" - "feature is still experimental and incomplete at the \n" + "If the GENERATE_PERLMOD tag is set to YES Doxygen will\n" + "generate a Perl module file that captures the structure of\n" + "the code including all documentation. Note that this\n" + "feature is still experimental and incomplete at the\n" "moment.", FALSE ); //---- cb = cfg->addBool( "PERLMOD_LATEX", - "If the PERLMOD_LATEX tag is set to YES Doxygen will generate \n" - "the necessary Makefile rules, Perl scripts and LaTeX code to be able \n" + "If the PERLMOD_LATEX tag is set to YES Doxygen will generate\n" + "the necessary Makefile rules, Perl scripts and LaTeX code to be able\n" "to generate PDF and DVI output from the Perl module output.", FALSE ); @@ -1646,12 +1652,12 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "PERLMOD_PRETTY", - "If the PERLMOD_PRETTY tag is set to YES the Perl module output will be \n" - "nicely formatted so it can be parsed by a human reader. \n" - "This is useful \n" - "if you want to understand what is going on. \n" - "On the other hand, if this \n" - "tag is set to NO the size of the Perl module output will be much smaller \n" + "If the PERLMOD_PRETTY tag is set to YES the Perl module output will be\n" + "nicely formatted so it can be parsed by a human reader.\n" + "This is useful\n" + "if you want to understand what is going on.\n" + "On the other hand, if this\n" + "tag is set to NO the size of the Perl module output will be much smaller\n" "and Perl will parse it just the same.", TRUE ); @@ -1659,30 +1665,30 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "PERLMOD_MAKEVAR_PREFIX", - "The names of the make variables in the generated doxyrules.make file \n" - "are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. \n" - "This is useful so different doxyrules.make files included by the same \n" + "The names of the make variables in the generated doxyrules.make file\n" + "are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.\n" + "This is useful so different doxyrules.make files included by the same\n" "Makefile don't overwrite each other's variables." ); cs->addDependency("GENERATE_PERLMOD"); //--------------------------------------------------------------------------- - cfg->addInfo("Preprocessor","Configuration options related to the preprocessor "); + cfg->addInfo("Preprocessor","Configuration options related to the preprocessor"); //--------------------------------------------------------------------------- //---- cb = cfg->addBool( "ENABLE_PREPROCESSING", - "If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will \n" - "evaluate all C-preprocessor directives found in the sources and include \n" + "If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will\n" + "evaluate all C-preprocessor directives found in the sources and include\n" "files.", TRUE ); //---- cb = cfg->addBool( "MACRO_EXPANSION", - "If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro \n" - "names in the source code. If set to NO (the default) only conditional \n" - "compilation will be performed. Macro expansion can be done in a controlled \n" + "If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro\n" + "names in the source code. If set to NO (the default) only conditional\n" + "compilation will be performed. Macro expansion can be done in a controlled\n" "way by setting EXPAND_ONLY_PREDEF to YES.", FALSE ); @@ -1690,8 +1696,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "EXPAND_ONLY_PREDEF", - "If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES \n" - "then the macro expansion is limited to the macros specified with the \n" + "If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES\n" + "then the macro expansion is limited to the macros specified with the\n" "PREDEFINED and EXPAND_AS_DEFINED tags.", FALSE ); @@ -1699,7 +1705,7 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "SEARCH_INCLUDES", - "If the SEARCH_INCLUDES tag is set to YES (the default) the includes files \n" + "If the SEARCH_INCLUDES tag is set to YES (the default) the includes files\n" "in the INCLUDE_PATH (see below) will be search if a #include is found.", TRUE ); @@ -1707,8 +1713,8 @@ void addConfigOptions(Config *cfg) //---- cl = cfg->addList( "INCLUDE_PATH", - "The INCLUDE_PATH tag can be used to specify one or more directories that \n" - "contain include files that are not input files but should be processed by \n" + "The INCLUDE_PATH tag can be used to specify one or more directories that\n" + "contain include files that are not input files but should be processed by\n" "the preprocessor." ); cl->addDependency("ENABLE_PREPROCESSING"); @@ -1716,152 +1722,152 @@ void addConfigOptions(Config *cfg) //---- cl = cfg->addList( "INCLUDE_FILE_PATTERNS", - "You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard \n" - "patterns (like *.h and *.hpp) to filter out the header-files in the \n" - "directories. If left blank, the patterns specified with FILE_PATTERNS will \n" + "You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard\n" + "patterns (like *.h and *.hpp) to filter out the header-files in the\n" + "directories. If left blank, the patterns specified with FILE_PATTERNS will\n" "be used." ); cl->addDependency("ENABLE_PREPROCESSING"); //---- cl = cfg->addList( "PREDEFINED", - "The PREDEFINED tag can be used to specify one or more macro names that \n" - "are defined before the preprocessor is started (similar to the -D option of \n" - "gcc). The argument of the tag is a list of macros of the form: name \n" - "or name=definition (no spaces). If the definition and the = are \n" - "omitted =1 is assumed. To prevent a macro definition from being \n" - "undefined via #undef or recursively expanded use the := operator \n" + "The PREDEFINED tag can be used to specify one or more macro names that\n" + "are defined before the preprocessor is started (similar to the -D option of\n" + "gcc). The argument of the tag is a list of macros of the form: name\n" + "or name=definition (no spaces). If the definition and the = are\n" + "omitted =1 is assumed. To prevent a macro definition from being\n" + "undefined via #undef or recursively expanded use the := operator\n" "instead of the = operator." ); cl->addDependency("ENABLE_PREPROCESSING"); //---- cl = cfg->addList( "EXPAND_AS_DEFINED", - "If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then \n" - "this tag can be used to specify a list of macro names that should be expanded. \n" - "The macro definition that is found in the sources will be used. \n" + "If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then\n" + "this tag can be used to specify a list of macro names that should be expanded.\n" + "The macro definition that is found in the sources will be used.\n" "Use the PREDEFINED tag if you want to use a different macro definition." ); cl->addDependency("ENABLE_PREPROCESSING"); //---- cb = cfg->addBool( "SKIP_FUNCTION_MACROS", - "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 \n" + "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\n" "the parser if not removed.", TRUE ); cb->addDependency("ENABLE_PREPROCESSING"); //--------------------------------------------------------------------------- - cfg->addInfo("External","Configuration::additions related to external references "); + cfg->addInfo("External","Configuration::additions related to external references"); //--------------------------------------------------------------------------- //---- cl = cfg->addList( "TAGFILES", - "The TAGFILES option can be used to specify one or more tagfiles. \n" - "Optionally an initial location of the external documentation \n" - "can be added for each tagfile. The format of a tag file without \n" - "this location is as follows: \n" - " \n" - "TAGFILES = file1 file2 ... \n" - "Adding location for the tag files is done as follows: \n" - " \n" - "TAGFILES = file1=loc1 \"file2 = loc2\" ... \n" - "where \"loc1\" and \"loc2\" can be relative or absolute paths or \n" - "URLs. If a location is present for each tag, the installdox tool \n" - "does not have to be run to correct the links. \n" - "Note that each tag file must have a unique name \n" - "(where the name does NOT include the path) \n" - "If a tag file is not located in the directory in which doxygen \n" + "The TAGFILES option can be used to specify one or more tagfiles.\n" + "Optionally an initial location of the external documentation\n" + "can be added for each tagfile. The format of a tag file without\n" + "this location is as follows:\n" + "\n" + "TAGFILES = file1 file2 ...\n" + "Adding location for the tag files is done as follows:\n" + "\n" + "TAGFILES = file1=loc1 \"file2 = loc2\" ...\n" + "where \"loc1\" and \"loc2\" can be relative or absolute paths or\n" + "URLs. If a location is present for each tag, the installdox tool\n" + "does not have to be run to correct the links.\n" + "Note that each tag file must have a unique name\n" + "(where the name does NOT include the path)\n" + "If a tag file is not located in the directory in which doxygen\n" "is run, you must also specify the path to the tagfile here." ); cl->setWidgetType(ConfigList::File); //---- cs = cfg->addString( "GENERATE_TAGFILE", - "When a file name is specified after GENERATE_TAGFILE, doxygen will create \n" + "When a file name is specified after GENERATE_TAGFILE, doxygen will create\n" "a tag file that is based on the input files it reads." ); cs->setWidgetType(ConfigString::File); //---- cb = cfg->addBool( "ALLEXTERNALS", - "If the ALLEXTERNALS tag is set to YES all external classes will be listed \n" - "in the class index. If set to NO only the inherited external classes \n" + "If the ALLEXTERNALS tag is set to YES all external classes will be listed\n" + "in the class index. If set to NO only the inherited external classes\n" "will be listed.", FALSE ); //---- cb = cfg->addBool( "EXTERNAL_GROUPS", - "If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed \n" - "in the modules index. If set to NO, only the current project's groups will \n" + "If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed\n" + "in the modules index. If set to NO, only the current project's groups will\n" "be listed.", TRUE ); //---- cs = cfg->addString( "PERL_PATH", - "The PERL_PATH should be the absolute path and name of the perl script \n" + "The PERL_PATH should be the absolute path and name of the perl script\n" "interpreter (i.e. the result of `which perl')." ); cs->setDefaultValue("/usr/bin/perl"); cs->setWidgetType(ConfigString::Dir); //--------------------------------------------------------------------------- - cfg->addInfo("Dot","Configuration options related to the dot tool "); + cfg->addInfo("Dot","Configuration options related to the dot tool"); //--------------------------------------------------------------------------- //---- cb = cfg->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 \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" + "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\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.", TRUE ); //---- cs = cfg->addString( "MSCGEN_PATH", - "You can define message sequence charts within doxygen comments using the \\msc \n" - "command. Doxygen will then run the mscgen tool (see \n" - "http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the \n" - "documentation. The MSCGEN_PATH tag allows you to specify the directory where \n" - "the mscgen tool resides. If left empty the tool is assumed to be found in the \n" + "You can define message sequence charts within doxygen comments using the \\msc\n" + "command. Doxygen will then run the mscgen tool (see\n" + "http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the\n" + "documentation. The MSCGEN_PATH tag allows you to specify the directory where\n" + "the mscgen tool resides. If left empty the tool is assumed to be found in the\n" "default search path." ); //---- cb = cfg->addBool( "HIDE_UNDOC_RELATIONS", - "If set to YES, the inheritance and collaboration graphs will hide \n" - "inheritance and usage relations if the target is undocumented \n" + "If set to YES, the inheritance and collaboration graphs will hide\n" + "inheritance and usage relations if the target is undocumented\n" "or is not a class.", TRUE ); //---- cb = cfg->addBool( "HAVE_DOT", - "If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is \n" - "available from the path. This tool is part of Graphviz, a graph visualization \n" - "toolkit from AT&T and Lucent Bell Labs. The other options in this section \n" + "If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is\n" + "available from the path. This tool is part of Graphviz, a graph visualization\n" + "toolkit from AT&T and Lucent Bell Labs. The other options in this section\n" "have no effect if this option is set to NO (the default)", FALSE ); //---- cs = cfg->addString( "DOT_FONTNAME", - "By default doxygen will write a font called FreeSans.ttf to the output \n" - "directory and reference it in all dot files that doxygen generates. This \n" - "font does not include all possible unicode characters however, so when you need \n" - "these (or just want a differently looking font) you can specify the font name \n" - "using DOT_FONTNAME. You need need to make sure dot is able to find the font, \n" - "which can be done by putting it in a standard location or by setting the \n" - "DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory \n" + "By default doxygen will write a font called FreeSans.ttf to the output\n" + "directory and reference it in all dot files that doxygen generates. This\n" + "font does not include all possible unicode characters however, so when you need\n" + "these (or just want a differently looking font) you can specify the font name\n" + "using DOT_FONTNAME. You need need to make sure dot is able to find the font,\n" + "which can be done by putting it in a standard location or by setting the\n" + "DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory\n" "containing the font." ); cs->setDefaultValue("FreeSans"); @@ -1869,7 +1875,7 @@ void addConfigOptions(Config *cfg) //---- ci = cfg->addInt( "DOT_FONTSIZE", - "The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. \n" + "The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.\n" "The default size is 10pt.", 4,24,10 ); @@ -1877,18 +1883,18 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "DOT_FONTPATH", - "By default doxygen will tell dot to use the output directory to look for the \n" - "FreeSans.ttf font (which doxygen will put there itself). If you specify a \n" - "different font using DOT_FONTNAME you can set the path where dot \n" + "By default doxygen will tell dot to use the output directory to look for the\n" + "FreeSans.ttf font (which doxygen will put there itself). If you specify a\n" + "different font using DOT_FONTNAME you can set the path where dot\n" "can find it using this tag." ); cs->addDependency("HAVE_DOT"); //---- cb = cfg->addBool( "CLASS_GRAPH", - "If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen \n" - "will generate a graph for each documented class showing the direct and \n" - "indirect inheritance relations. Setting this tag to YES will force the \n" + "If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen\n" + "will generate a graph for each documented class showing the direct and\n" + "indirect inheritance relations. Setting this tag to YES will force the\n" "the CLASS_DIAGRAMS tag to NO.", TRUE ); @@ -1896,9 +1902,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "COLLABORATION_GRAPH", - "If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen \n" - "will generate a graph for each documented class showing the direct and \n" - "indirect implementation dependencies (inheritance, containment, and \n" + "If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen\n" + "will generate a graph for each documented class showing the direct and\n" + "indirect implementation dependencies (inheritance, containment, and\n" "class references variables) of the class with other documented classes.", TRUE ); @@ -1906,7 +1912,7 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GROUP_GRAPHS", - "If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen \n" + "If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen\n" "will generate a graph for groups, showing the direct groups dependencies", TRUE ); @@ -1914,8 +1920,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "UML_LOOK", - "If the UML_LOOK tag is set to YES doxygen will generate inheritance and \n" - "collaboration diagrams in a style similar to the OMG's Unified Modeling \n" + "If the UML_LOOK tag is set to YES doxygen will generate inheritance and\n" + "collaboration diagrams in a style similar to the OMG's Unified Modeling\n" "Language.", FALSE ); @@ -1923,7 +1929,7 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "TEMPLATE_RELATIONS", - "If set to YES, the inheritance and collaboration graphs will show the \n" + "If set to YES, the inheritance and collaboration graphs will show the\n" "relations between templates and their instances.", FALSE ); @@ -1931,9 +1937,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "INCLUDE_GRAPH", - "If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT \n" - "tags are set to YES then doxygen will generate a graph for each documented \n" - "file showing the direct and indirect include dependencies of the file with \n" + "If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT\n" + "tags are set to YES then doxygen will generate a graph for each documented\n" + "file showing the direct and indirect include dependencies of the file with\n" "other documented files.", TRUE ); @@ -1941,9 +1947,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "INCLUDED_BY_GRAPH", - "If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and \n" - "HAVE_DOT tags are set to YES then doxygen will generate a graph for each \n" - "documented header file showing the documented files that directly or \n" + "If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and\n" + "HAVE_DOT tags are set to YES then doxygen will generate a graph for each\n" + "documented header file showing the documented files that directly or\n" "indirectly include this file.", TRUE ); @@ -1951,10 +1957,10 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "CALL_GRAPH", - "If the CALL_GRAPH and HAVE_DOT options are set to YES then \n" - "doxygen will generate a call dependency graph for every global function \n" - "or class method. Note that enabling this option will significantly increase \n" - "the time of a run. So in most cases it will be better to enable call graphs \n" + "If the CALL_GRAPH and HAVE_DOT options are set to YES then\n" + "doxygen will generate a call dependency graph for every global function\n" + "or class method. Note that enabling this option will significantly increase\n" + "the time of a run. So in most cases it will be better to enable call graphs\n" "for selected functions only using the \\callgraph command.", FALSE ); @@ -1962,10 +1968,10 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "CALLER_GRAPH", - "If the CALLER_GRAPH and HAVE_DOT tags are set to YES then \n" - "doxygen will generate a caller dependency graph for every global function \n" - "or class method. Note that enabling this option will significantly increase \n" - "the time of a run. So in most cases it will be better to enable caller \n" + "If the CALLER_GRAPH and HAVE_DOT tags are set to YES then\n" + "doxygen will generate a caller dependency graph for every global function\n" + "or class method. Note that enabling this option will significantly increase\n" + "the time of a run. So in most cases it will be better to enable caller\n" "graphs for selected functions only using the \\callergraph command.", FALSE ); @@ -1973,7 +1979,7 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "GRAPHICAL_HIERARCHY", - "If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen \n" + "If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen\n" "will graphical hierarchy of all classes instead of a textual one.", TRUE ); @@ -1981,9 +1987,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "DIRECTORY_GRAPH", - "If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES \n" - "then doxygen will show the dependencies a directory has on other directories \n" - "in a graphical way. The dependency relations are determined by the #include \n" + "If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES\n" + "then doxygen will show the dependencies a directory has on other directories\n" + "in a graphical way. The dependency relations are determined by the #include\n" "relations between the files in the directories.", TRUE ); @@ -1991,8 +1997,8 @@ void addConfigOptions(Config *cfg) //---- ce = cfg->addEnum( "DOT_IMAGE_FORMAT", - "The DOT_IMAGE_FORMAT tag can be used to set the image format of the images \n" - "generated by dot. Possible values are png, jpg, or gif \n" + "The DOT_IMAGE_FORMAT tag can be used to set the image format of the images\n" + "generated by dot. Possible values are png, jpg, or gif\n" "If left blank png will be used.", "png" ); @@ -2003,7 +2009,7 @@ void addConfigOptions(Config *cfg) //---- cs = cfg->addString( "DOT_PATH", - "The tag DOT_PATH can be used to specify the path where the dot tool can be \n" + "The tag DOT_PATH can be used to specify the path where the dot tool can be\n" "found. If left blank, it is assumed the dot tool can be found in the path." ); cs->setWidgetType(ConfigString::Dir); @@ -2011,8 +2017,8 @@ void addConfigOptions(Config *cfg) //---- cl = cfg->addList( "DOTFILE_DIRS", - "The DOTFILE_DIRS tag can be used to specify one or more directories that \n" - "contain dot files that are included in the documentation (see the \n" + "The DOTFILE_DIRS tag can be used to specify one or more directories that\n" + "contain dot files that are included in the documentation (see the\n" "\\dotfile command)." ); cl->addDependency("HAVE_DOT"); @@ -2020,12 +2026,12 @@ void addConfigOptions(Config *cfg) //---- ci = cfg->addInt( "DOT_GRAPH_MAX_NODES", - "The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of \n" - "nodes that will be shown in the graph. If the number of nodes in a graph \n" - "becomes larger than this value, doxygen will truncate the graph, which is \n" - "visualized by representing a node as a red box. Note that doxygen if the \n" - "number of direct children of the root node in a graph is already larger than \n" - "DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note \n" + "The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of\n" + "nodes that will be shown in the graph. If the number of nodes in a graph\n" + "becomes larger than this value, doxygen will truncate the graph, which is\n" + "visualized by representing a node as a red box. Note that doxygen if the\n" + "number of direct children of the root node in a graph is already larger than\n" + "DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note\n" "that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.", 0,10000,50 ); @@ -2033,12 +2039,12 @@ void addConfigOptions(Config *cfg) //---- ci = cfg->addInt( "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 \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 the size of a graph can be further restricted by \n" + "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\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 the size of a graph can be further restricted by\n" "DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.", 0,1000,0 ); @@ -2046,10 +2052,10 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "DOT_TRANSPARENT", - "Set the DOT_TRANSPARENT tag to YES to generate images with a transparent \n" - "background. This is disabled by default, because dot on Windows does not \n" - "seem to support this out of the box. Warning: Depending on the platform used, \n" - "enabling this option may lead to badly anti-aliased labels on the edges of \n" + "Set the DOT_TRANSPARENT tag to YES to generate images with a transparent\n" + "background. This is disabled by default, because dot on Windows does not\n" + "seem to support this out of the box. Warning: Depending on the platform used,\n" + "enabling this option may lead to badly anti-aliased labels on the edges of\n" "a graph (i.e. they become hard to read).", FALSE ); @@ -2057,9 +2063,9 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->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" + "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.", FALSE ); @@ -2067,8 +2073,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->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" + "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" "arrows in the dot generated graphs.", TRUE ); @@ -2076,8 +2082,8 @@ void addConfigOptions(Config *cfg) //---- cb = cfg->addBool( "DOT_CLEANUP", - "If the DOT_CLEANUP tag is set to YES (the default) Doxygen will \n" - "remove the intermediate dot files that are used to generate \n" + "If the DOT_CLEANUP tag is set to YES (the default) Doxygen will\n" + "remove the intermediate dot files that are used to generate\n" "the various graphs.", TRUE ); diff --git a/src/diagram.cpp b/src/diagram.cpp index 75a0e00..dd6e601 100644 --- a/src/diagram.cpp +++ b/src/diagram.cpp @@ -392,7 +392,7 @@ void TreeDiagram::computeLayout() // re-organize the diagram items DiagramItem *root=getFirst()->getFirst(); - while (layoutTree(root,0)); + while (layoutTree(root,0)) { } // move first items of the lists if (row) @@ -1289,8 +1289,9 @@ void ClassDiagram::writeImage(QTextStream &t,const char *path, base->drawConnectors(t,&image,TRUE,TRUE,baseRows,superRows,cellWidth,cellHeight); super->drawConnectors(t,&image,FALSE,TRUE,baseRows,superRows,cellWidth,cellHeight); - image.save((QCString)path+"/"+fileName+".png"); - Doxygen::indexList.addImageFile(QCString(fileName)+".png"); +#define IMAGE_EXT ".gif" + image.save((QCString)path+"/"+fileName+IMAGE_EXT); + Doxygen::indexList.addImageFile(QCString(fileName)+IMAGE_EXT); if (generateMap) t << "</map>" << endl; } diff --git a/src/docparser.cpp b/src/docparser.cpp index 2def120..3817d02 100644 --- a/src/docparser.cpp +++ b/src/docparser.cpp @@ -4468,7 +4468,7 @@ int DocPara::handleStartCode() int retval = doctokenizerYYlex(); // search for the first non-whitespace line, index is stored in li int i=0,li=0,l=g_token->verb.length(); - while (i<l && g_token->verb.at(i)==' ' || g_token->verb.at(i)=='\n') + while (i<l && (g_token->verb.at(i)==' ' || g_token->verb.at(i)=='\n')) { if (g_token->verb.at(i)=='\n') li=i+1; i++; diff --git a/src/docsets.cpp b/src/docsets.cpp index 76d7679..f2bda2d 100644 --- a/src/docsets.cpp +++ b/src/docsets.cpp @@ -244,16 +244,18 @@ void DocSets::addIndexItem(const char *, const char *, switch (langExt) { case SrcLangExt_Cpp: + case SrcLangExt_ObjC: { - if (md->isObjCMethod()) + if (md->isObjCMethod() || md->isObjCProperty()) lang="occ"; // Objective C/C++ else if (fd && fd->name().right(2).lower()==".c") lang="c"; // Plain C + else if (cd==0 && nd==0) + lang="c"; // Plain C symbol outside any class or namespace else lang="cpp"; // C++ } break; - case SrcLangExt_ObjC: lang="occ"; break; // Objective C++ case SrcLangExt_IDL: lang="idl"; break; // IDL case SrcLangExt_CSharp: lang="csharp"; break; // C# case SrcLangExt_PHP: lang="php"; break; // PHP4/5 @@ -282,7 +284,10 @@ void DocSets::addIndexItem(const char *, const char *, if (cd->isTemplate()) type="tmplt"; else if (cd->compoundType()==ClassDef::Protocol) + { type="intf"; + if (scope.right(2)=="-p") scope=scope.left(scope.length()-2); + } else if (cd->compoundType()==ClassDef::Interface) type="cl"; else if (cd->compoundType()==ClassDef::Category) @@ -317,10 +322,22 @@ void DocSets::addIndexItem(const char *, const char *, case MemberDef::Define: type="macro"; break; case MemberDef::Function: - if (cd && cd->compoundType()==ClassDef::Interface) - type="intfm"; - else if (cd && cd->compoundType()==ClassDef::Class) - type="clm"; + if (cd && (cd->compoundType()==ClassDef::Interface || + cd->compoundType()==ClassDef::Class) + ) + { + if (md->isStatic()) + type="clm"; + else + type="instm"; + } + else if (cd && cd->compoundType()==ClassDef::Protocol) + { + if (md->isStatic()) + type="intfcm"; + else + type="intfm"; + } else type="func"; break; @@ -343,7 +360,11 @@ void DocSets::addIndexItem(const char *, const char *, case MemberDef::DCOP: type="dcop"; break; case MemberDef::Property: - type="property"; break; + if (cd && cd->compoundType()==ClassDef::Protocol) + type="intfp"; + else + type="instp"; + break; case MemberDef::Event: type="event"; break; } diff --git a/src/doctokenizer.l b/src/doctokenizer.l index e095dff..399371e 100644 --- a/src/doctokenizer.l +++ b/src/doctokenizer.l @@ -329,9 +329,8 @@ LNKWORD1 ("::"|"#")?{SCOPEMASK} CVSPEC {BLANK}*("const"|"volatile") LNKWORD2 ({SCOPEPRE}*"operator"{OPMASK})|({SCOPEPRE}"operator"{OPMASKOPT})|(("::"|"#"){SCOPEPRE}*"operator"{OPMASKOPT}) LNKWORD3 ([0-9a-z_A-Z\-]+("/"|"\\"))*[0-9a-z_A-Z\-]+("."[0-9a-z_A-Z]+)+ -CHARWORD [^ \t\n\r\\@<>()\[\]:;\?{}&%$#,.] CHARWORDQ [^ \t\n\r\\@<>()\[\]:;\?{}&%$#,."] -WORD1 "%"?{CHARWORD}+|"{"|"}"|("\""[^"\n]*"\"") +WORD1 "%"?{CHARWORDQ}+|"{"|"}"|("\""[^"\n]*\n?[^"\n]*"\"") WORD2 "."|","|"("|")"|"["|"]"|":"|";"|"\?" WORD1NQ "%"?{CHARWORDQ}+ WORD2NQ "."|","|"("|")"|"["|"]"|":"|";"|"\?" diff --git a/src/dot.cpp b/src/dot.cpp index 6382488..5014f93 100644 --- a/src/dot.cpp +++ b/src/dot.cpp @@ -131,7 +131,9 @@ static bool convertMapFile(QTextStream &t,const char *mapName, QFile f(mapName); if (!f.open(IO_ReadOnly)) { - err("Error opening map file %s for inclusion in the docs!\n",mapName); + err("Error opening map file %s for inclusion in the docs!\n" + "If you installed Graphviz/dot after a previous failing run, \n" + "try deleting the output directory and rerun doxygen.\n",mapName); return FALSE; } const int maxLineLen=10240; @@ -877,7 +879,7 @@ void DotNode::writeXML(QTextStream &t,bool isClassGraph) void DotNode::writeDEF(QTextStream &t) { - char* nodePrefix = " node-"; + const char* nodePrefix = " node-"; t << " node = {" << endl; t << nodePrefix << "id = " << m_number << ';' << endl; @@ -1919,7 +1921,7 @@ QCString DotClassGraph::writeGraph(QTextStream &out, { QCString mapLabel = escapeCharsInString(m_startNode->m_label,FALSE)+"_"+ escapeCharsInString(mapName,FALSE); - out << "<center><img src=\"" << relPath << baseName << "." + out << "<div class=\"center\"><img src=\"" << relPath << baseName << "." << imgExt << "\" border=\"0\" usemap=\"#" << mapLabel << "\" alt=\""; switch (m_graphType) @@ -1934,7 +1936,7 @@ QCString DotClassGraph::writeGraph(QTextStream &out, ASSERT(0); break; } - out << "\"/></center>" << endl; + out << "\"/></div>" << endl; QString tmpstr; QTextOStream tmpout(&tmpstr); tmpout.setEncoding(tmpout.UnicodeUTF8); @@ -2249,10 +2251,10 @@ QCString DotInclDepGraph::writeGraph(QTextStream &out, if (format==BITMAP && generateImageMap) { - out << "<center><img src=\"" << relPath << baseName << "." + out << "<div class=\"center\"><img src=\"" << relPath << baseName << "." << imgExt << "\" border=\"0\" usemap=\"#" << mapName << "_map\" alt=\"\"/>"; - out << "</center>" << endl; + out << "</div>" << endl; QString tmpstr; QTextOStream tmpout(&tmpstr); tmpout.setEncoding(tmpout.UnicodeUTF8); @@ -2542,11 +2544,11 @@ QCString DotCallGraph::writeGraph(QTextStream &out, GraphOutputFormat format, if (format==BITMAP && generateImageMap) { - out << "<center><img src=\"" << relPath << baseName << "." + out << "<div class=\"center\"><img src=\"" << relPath << baseName << "." << imgExt << "\" border=\"0\" usemap=\"#" << mapName << "_map\" alt=\""; out << "\">"; - out << "</center>" << endl; + out << "</div>" << endl; QString tmpstr; QTextOStream tmpout(&tmpstr); tmpout.setEncoding(tmpout.UnicodeUTF8); @@ -2684,12 +2686,12 @@ QCString DotDirDeps::writeGraph(QTextStream &out, if (format==BITMAP && generateImageMap) { - out << "<center><img src=\"" << relPath << baseName << "." + out << "<div class=\"center\"><img src=\"" << relPath << baseName << "." << imgExt << "\" border=\"0\" usemap=\"#" << mapName << "_map\" alt=\""; out << convertToXML(m_dir->displayName()); out << "\"/>"; - out << "</center>" << endl; + out << "</div>" << endl; QString tmpstr; QTextOStream tmpout(&tmpstr); tmpout.setEncoding(tmpout.UnicodeUTF8); diff --git a/src/doxygen.cpp b/src/doxygen.cpp index 8b063f1..5a2c5da 100644 --- a/src/doxygen.cpp +++ b/src/doxygen.cpp @@ -1065,19 +1065,20 @@ static void addClassToContext(EntryNav *rootNav) { scName=rootNav->parent()->name(); } - // name without parent's scope: TODO: is this still true? + // name without parent's scope QCString fullName = root->name; // strip off any template parameters (but not those for specializations) fullName=stripTemplateSpecifiersFromScope(fullName); - // name with scope + // name with scope (if not present already) QCString qualifiedName = fullName; if (!scName.isEmpty() && !leftScopeMatch(fullName,scName)) { qualifiedName.prepend(scName+"::"); } + // see if we already found the class before ClassDef *cd = getClass(qualifiedName); Debug::print(Debug::Classes,0, " Found class with name %s (qualifiedName=%s -> cd=%p)\n", @@ -1092,50 +1093,16 @@ static void addClassToContext(EntryNav *rootNav) // //printf("existing ClassDef tempArgList=%p specScope=%s\n",root->tArgList,root->scopeSpec.data()); // cd->setTemplateArguments(tArgList); //} -#if 0 - if (!root->doc.isEmpty() || !root->brief.isEmpty() || - (root->bodyLine!=-1 && Config_getBool("SOURCE_BROWSER")) - ) - // block contains something that ends up in the docs - { - if (!root->doc.isEmpty() && !cd->documentation().isEmpty()) - { - warn( - root->fileName,root->startLine, - "Warning: class %s already has a detailed description found in file %s at line %d. " - "Skipping the one found here.", - fullName.data(),cd->docFile().data(),cd->docLine() - ); - } - else if (!root->doc.isEmpty()) -#endif - { - cd->setDocumentation(root->doc,root->docFile,root->docLine); - } -#if 0 - if (!root->brief.isEmpty() && !cd->briefDescription().isEmpty()) - { - warn( - root->fileName,root->startLine, - "Warning: class %s already has a brief description found in file %s at line %d\n" - " skipping the one found here.", - fullName.data(),cd->briefFile().data(),cd->briefLine() - ); - } - else if (!root->brief.isEmpty()) -#endif - { - cd->setBriefDescription(root->brief,root->briefFile,root->briefLine); - } - if (root->bodyLine!=-1 && cd->getStartBodyLine()==-1) - { - cd->setBodySegment(root->bodyLine,root->endBodyLine); - cd->setBodyDef(fd); - } - //cd->setName(fullName); // change name to match docs -#if 0 + + cd->setDocumentation(root->doc,root->docFile,root->docLine); + cd->setBriefDescription(root->brief,root->briefFile,root->briefLine); + + if (root->bodyLine!=-1 && cd->getStartBodyLine()==-1) + { + cd->setBodySegment(root->bodyLine,root->endBodyLine); + cd->setBodyDef(fd); } -#endif + //cd->setName(fullName); // change name to match docs if (cd->templateArguments()==0) { @@ -3921,7 +3888,9 @@ static bool findTemplateInstanceRelation(Entry *root, //} //printf("\n"); - bool existingClass = (templSpec==tempArgListToString(templateClass->templateArguments())); + bool existingClass = (templSpec == + tempArgListToString(templateClass->templateArguments()) + ); if (existingClass) return TRUE; bool freshInstance=FALSE; @@ -4175,7 +4144,7 @@ static bool findClassRelation( //printf("baseClass==0 i=%d e=%d\n",i,e); if (e!=-1) // end of template was found at e { - templSpec=baseClassName.mid(i,e-i); + templSpec=removeRedundantWhiteSpace(baseClassName.mid(i,e-i)); baseClassName=baseClassName.left(i)+baseClassName.right(baseClassName.length()-e); baseClass=getResolvedClass(cd, cd->getFileDef(), @@ -5512,6 +5481,9 @@ static void findMember(EntryNav *rootNav, NamespaceDef *nd=0; if (!namespaceName.isEmpty()) nd=getResolvedNamespace(namespaceName); + //printf("scopeName %s->%s\n",scopeName.data(), + // stripTemplateSpecifiersFromScope(scopeName,FALSE).data()); + ClassDef *tcd=findClassDefinition(fd,nd,scopeName); if (tcd==0 && stripAnonymousNamespaceScope(cd->name())==scopeName) { diff --git a/src/doxygen.css b/src/doxygen.css index b5debd1..9ca3caf 100644 --- a/src/doxygen.css +++ b/src/doxygen.css @@ -32,7 +32,7 @@ div.multicol { } p.startli, p.startdd { - margin-top: 0px; + margin-top: 2px; } p.endli { @@ -191,12 +191,19 @@ img.formulaInl { vertical-align: middle; } -img.center { - border: 0; +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; } img.footer { - border: 0; + border: 0px; vertical-align: middle; } diff --git a/src/doxygen.pro.in b/src/doxygen.pro.in index 6512e0d..f359ac1 100644 --- a/src/doxygen.pro.in +++ b/src/doxygen.pro.in @@ -18,18 +18,17 @@ TEMPLATE = app.t CONFIG = console warn_on $extraopts HEADERS = doxygen.h SOURCES = main.cpp -unix:LIBS += -L../lib -ldoxygen -ldoxycfg -lqtools -lpng -lmd5 +unix:LIBS += -L../lib -ldoxygen -ldoxycfg -lqtools -lmd5 win32:INCLUDEPATH += . -win32-mingw:LIBS += -L../lib -ldoxygen -ldoxycfg -lqtools -lpng -lmd5 -win32-msvc:LIBS += qtools.lib png.lib md5.lib doxygen.lib doxycfg.lib shell32.lib iconv.lib +win32-mingw:LIBS += -L../lib -ldoxygen -ldoxycfg -lqtools -lmd5 +win32-msvc:LIBS += qtools.lib md5.lib doxygen.lib doxycfg.lib shell32.lib iconv.lib win32-msvc:TMAKE_LFLAGS += /LIBPATH:..\lib -win32-borland:LIBS += qtools.lib png.lib md5.lib doxygen.lib doxycfg.lib shell32.lib iconv.lib +win32-borland:LIBS += qtools.lib md5.lib doxygen.lib doxycfg.lib shell32.lib iconv.lib win32-borland:TMAKE_LFLAGS += -L..\lib -L$(BCB)\lib\psdk win32:TMAKE_CXXFLAGS += -DQT_NODLL -win32-g++:LIBS = -L../lib -ldoxygen -ldoxycfg -lqtools -lpng -lmd5 -liconv +win32-g++:LIBS = -L../lib -ldoxygen -ldoxycfg -lqtools -lmd5 -liconv win32-g++:TMAKE_CXXFLAGS += -fno-exceptions -fno-rtti -INCLUDEPATH += ../qtools ../libpng ../libmd5 . -#win32-g++:INCLUDEPATH -= ../libpng +INCLUDEPATH += ../qtools ../libmd5 . DESTDIR = ../bin TARGET = doxygen unix:TARGETDEPS = ../lib/libdoxygen.a ../lib/libdoxycfg.a diff --git a/src/doxygen_css.h b/src/doxygen_css.h index 1584e69..00e94a4 100644 --- a/src/doxygen_css.h +++ b/src/doxygen_css.h @@ -32,7 +32,7 @@ "}\n" "\n" "p.startli, p.startdd {\n" -" margin-top: 0px;\n" +" margin-top: 2px;\n" "}\n" "\n" "p.endli {\n" @@ -191,12 +191,19 @@ " vertical-align: middle;\n" "}\n" "\n" -"img.center {\n" -" border: 0;\n" +"div.center {\n" +" text-align: center;\n" +" margin-top: 0px;\n" +" margin-bottom: 0px;\n" +" padding: 0px;\n" +"}\n" +"\n" +"div.center img {\n" +" border: 0px;\n" "}\n" "\n" "img.footer {\n" -" border: 0;\n" +" border: 0px;\n" " vertical-align: middle;\n" "}\n" "\n" diff --git a/src/formula.cpp b/src/formula.cpp index 11ea644..0ba3e22 100644 --- a/src/formula.cpp +++ b/src/formula.cpp @@ -204,7 +204,7 @@ void FormulaList::generateBitmaps(const char *path) { // assume the size if after the first line that does not start with // # excluding the first line of the file. - while (!t.eof() && (s=t.readLine()) && !s.isEmpty() && s.at(0)=='#'); + while (!t.eof() && (s=t.readLine()) && !s.isEmpty() && s.at(0)=='#') { } sscanf(s,"%d %d",&imageX,&imageY); } if (imageX>0 && imageY>0) diff --git a/src/fortrancode.l b/src/fortrancode.l index 59b16fc..2cb9b30 100644 --- a/src/fortrancode.l +++ b/src/fortrancode.l @@ -70,6 +70,18 @@ class UseSDict : public SDict<UseEntry> UseSDict() : SDict<UseEntry>(17) {} }; +/** + Contains names of used modules and names of local variables. +*/ +class Scope +{ + public: + QStringList useNames; //!< contains names of used modules + QDict<void> localVars; //!< contains names of local variables + + Scope() : localVars(7, FALSE /*caseSensitive*/) {} +}; + /*===================================================================*/ /* * statics @@ -79,8 +91,8 @@ static QCString docBlock; //!< contents of all lines of a doc static QCString currentModule=0; //!< name of the current enclosing module static UseSDict *useMembers= new UseSDict; //!< info about used modules static UseEntry *useEntry = 0; //!< current use statement info -static QStack<QStringList> useStack; //!< contains names of used modules for current program tree -static QStringList *currentUseNames= new QStringList; //! contains names of used modules of current program unit +static QList<Scope> scopeStack; +// static QStringList *currentUseNames= new QStringList; //! contains names of used modules of current program unit static QCString str=""; //!> contents of fortran string static CodeOutputInterface * g_code; @@ -109,6 +121,9 @@ static MemberDef * g_currentMemberDef; static bool g_includeCodeFragment; static char stringStartSymbol; // single or double quote +// count in variable declaration to filter out +// declared from referenced names +static int bracketCount = 0; // simplified way to know if this is fixed form // duplicate in fortranscanner.l @@ -117,10 +132,12 @@ static bool recognizeFixedForm(const char* contents) int column=0; bool skipLine=FALSE; - for(int i=0;;i++) { + for (int i=0;;i++) + { column++; - switch(contents[i]) { + switch(contents[i]) + { case '\n': column=0; skipLine=FALSE; @@ -262,7 +279,7 @@ static void codifyLines(char *text) while (!done) { sp=p; - while ((c=*p++) && c!='\n'); + while ((c=*p++) && c!='\n') { } if (c=='\n') { g_yyLineNr++; @@ -304,7 +321,7 @@ static void writeMultiLineCodeLink(CodeOutputInterface &ol, { char *sp=p; char c; - while ((c=*p++) && c!='\n'); + while ((c=*p++) && c!='\n') { } if (c=='\n') { g_yyLineNr++; @@ -400,6 +417,13 @@ static bool getFortranDefs(const QCString &memberName, const QCString &moduleNam { if (memberName.isEmpty()) return FALSE; /* empty name => nothing to link */ + // look in local variables + for (Scope *scope=scopeStack.last(); scope!=NULL; scope=scopeStack.prev()) + { + if(scope->localVars.find(memberName)) + return FALSE; + } + // search for function MemberName *mn = Doxygen::functionNameSDict->find(memberName); @@ -477,7 +501,6 @@ static bool getLink(UseSDict *usedict, // dictonary with used modules { MemberDef *md; QCString memberName= removeRedundantWhiteSpace(memberText); - //printf("Trying `%s'::`%s'\n",c.data(),m.data()); if (getFortranDefs(memberName, currentModule, md, usedict) && md->isLinkable()) { @@ -562,38 +585,46 @@ static int countLines() } //---------------------------------------------------------------------------- -/** start use list */ -void startUseScope() +/** start scope */ +void startScope() { - //fprintf("===> startUse %s",yytext); - useStack.push(currentUseNames); - currentUseNames= new QStringList; + // fprintf(stderr, "===> startScope %s",yytext); + Scope *scope = new Scope; + scopeStack.append(scope); } -/** end use list */ -void endUseScope() +/** end scope */ +void endScope() { - //fprintf(stderr,"===> endUse %s",yytext); - //UseSDict::Iterator di(*useMembers); UseEntry *ue; - //for (di.toFirst(); ue=di.current(); ++di){cout << ue->module ;} cout << endl; - - for ( QStringList::Iterator it = currentUseNames->begin(); it != currentUseNames->end(); ++it) + // fprintf(stderr,"===> endScope %s",yytext); + if (scopeStack.isEmpty()) { - useMembers->remove(*it); + fprintf(stderr,"WARNING: fortrancode.l: stack empty!"); + return; + //exit(-1); } - delete currentUseNames; - currentUseNames= useStack.pop(); - if (currentUseNames == 0) + + Scope *scope = scopeStack.getLast(); + scopeStack.removeLast(); + for ( QStringList::Iterator it = scope->useNames.begin(); it != scope->useNames.end(); ++it) { - fprintf(stderr,"WARNING: fortrancode.l: stack empty!"); - //exit(-1); + useMembers->remove(*it); } + delete scope; } void addUse(QString moduleName) { - currentUseNames->append(moduleName); + if (!scopeStack.isEmpty()) + scopeStack.last()->useNames.append(moduleName); } + +void addLocalVar(QString varName) +{ + if (!scopeStack.isEmpty()) + scopeStack.last()->localVars.insert(varName, (void*)1); +} + //---------------------------------------------------------------------------- /* -----------------------------------------------------------------*/ @@ -713,13 +744,13 @@ IGNORE (CALL) /*-------- fortran module -----------------------------------------*/ <Start>("program"|"module"|"type"|"interface")/{BS_}|({COMMA}{ACCESS_SPEC})|\n { // - startUseScope(); + startScope(); startFontClass("keyword"); codifyLines(yytext); endFontClass(); yy_push_state(YY_START); BEGIN(ClassName); - if (!strcmp(yytext,"module")) currentModule="module"; + if (!stricmp(yytext,"module")) currentModule="module"; } <ClassName>{ID} { if (currentModule == "module") currentModule=yytext; @@ -730,12 +761,12 @@ IGNORE (CALL) yy_pop_state(); REJECT; } -<Start>"end"({BS_}"module")?.* { // just reset currentModule, rest is done in following rule +<Start>"end"({BS_}"module").* { // just reset currentModule, rest is done in following rule currentModule=0; REJECT; } <Start>^{BS}"end"({BS}("program"|"module"|"type"|"interface")({BS_}{ID})?)?{BS}/(\n|!) { // - endUseScope(); + endScope(); startFontClass("keyword"); codifyLines(yytext); endFontClass(); @@ -755,8 +786,8 @@ IGNORE (CALL) BEGIN(Subprog); } <Subprog>{ID} { // subroutine/function name - //cout << "===> start procedure " << yytext << endl; - startUseScope(); + // fprintf(stderr, "===> start subprogram %s\n", yytext); + startScope(); generateLink(*g_code,yytext); } <Subprog>"(".* { // ignore rest of line @@ -765,9 +796,9 @@ IGNORE (CALL) <Subprog>"\n" { codifyLines(yytext); yy_pop_state(); } -<Start>"^{BS}end"({BS}{SUBPROG}({BS_}{ID})?)?{BS}/(\n|!) { // Fortran subroutine or function ends +<Start>^{BS}"end"({BS}{SUBPROG}({BS_}{ID})?)?{BS}/(\n|!) { // Fortran subroutine or function ends //cout << "===> end function " << yytext << endl; - endUseScope(); + endScope(); startFontClass("keyword"); codifyLines(yytext); endFontClass(); @@ -808,16 +839,33 @@ IGNORE (CALL) g_code->codify(yytext); endFontClass(); } +<Declaration>{ID} { // local var + g_code->codify(yytext); + if (g_currentMemberDef && g_currentMemberDef->isFunction()) + addLocalVar(yytext); + } +<Declaration>[(] { // start of array specification + bracketCount++; + g_code->codify(yytext); + } + +<Declaration>[)] { // end array specification + bracketCount--; + g_code->codify(yytext); + } + <Declaration>"&" { // continuation line yy_push_state(YY_START); BEGIN(DeclContLine); } <DeclContLine>"\n" { // declaration not yet finished codifyLines(yytext); + bracketCount = 0; yy_pop_state(); } <Declaration>"\n" { // end declaration line codifyLines(yytext); + bracketCount = 0; yy_pop_state(); } @@ -895,6 +943,10 @@ IGNORE (CALL) endFontClass(); } /*------ variable references? -------------------------------------*/ + +<Start>"%"{BS}{ID} { // ignore references to elements + g_code->codify(yytext); + } <Start>{ID} { g_insideBody=TRUE; generateLink(*g_code, yytext); diff --git a/src/fortranscanner.l b/src/fortranscanner.l index 97909f0..62c1882 100644 --- a/src/fortranscanner.l +++ b/src/fortranscanner.l @@ -595,10 +595,9 @@ PREFIX (RECURSIVE{BS_}|PURE{BS_}|ELEMENTAL{BS_}){0,2}(RECURSIVE|PURE|ELEMENTA /* remember attributes for the symbol */ modifiers[current_root][name.lower()] |= currentModifiers; argName= name; - int last= yy_top_state(); v_type= V_IGNORE; - if (!argType.isEmpty() && last != SubprogBody) + if (!argType.isEmpty() && current_root->section!=Entry::FUNCTION_SEC) { // new variable entry v_type = V_VARIABLE; current->section = Entry::VARIABLE_SEC; @@ -691,7 +690,7 @@ PREFIX (RECURSIVE{BS_}|PURE{BS_}|ELEMENTAL{BS_}){0,2}(RECURSIVE|PURE|ELEMENTA } <Subprog>{BS} { /* ignore white space */ } -<Subprog>{ID} { current->name = yytext; +<Subprog>{ID} { current->name = yytext; //cout << "1a==========> got " << current->type << " " << yytext << " " << yyLineNr << endl; modifiers[current_root][current->name.lower()].returnName = current->name; BEGIN(Parameterlist); @@ -1220,11 +1219,13 @@ static Argument *findArgument(Entry* subprog, QCString name, bool byTypeName = F for (unsigned int i=0; i<subprog->argList->count(); i++) { Argument *arg = subprog->argList->at(i); - if (!byTypeName && arg->name.lower() == cname || - byTypeName && arg->type.lower() == cname) + if ((!byTypeName && arg->name.lower() == cname) || + (byTypeName && arg->type.lower() == cname) + ) + { return arg; + } } - return 0; } @@ -1764,6 +1765,9 @@ static void scanner_abort() if (ce == file_root) start=TRUE; if (start) ce->reset(); } + + // dummy call to avoid compiler warning + (void)yy_top_state(); return; //exit(-1); @@ -1774,7 +1778,7 @@ static void scanner_abort() #if !defined(YY_FLEX_SUBMINOR_VERSION) //---------------------------------------------------------------------------- extern "C" { // some bogus code to keep the compiler happy - void fscannerYYdummy() { yy_flex_realloc(0,0); yy_top_state(); } + void fscannerYYdummy() { yy_flex_realloc(0,0); } } #endif diff --git a/src/ftvhelp.cpp b/src/ftvhelp.cpp index 3988c57..17b4466 100644 --- a/src/ftvhelp.cpp +++ b/src/ftvhelp.cpp @@ -727,13 +727,15 @@ void FTVHelp::generateTreeView(QString* OutString) if (searchEngine) { t << " <script type=\"text/javascript\"><!--\n"; - t << " var searchBox = new SearchBox(\"searchBox\", \"search\", true);\n"; + t << " var searchBox = new SearchBox(\"searchBox\", \"search\", true, '" + << theTranslator->trSearch() << "');\n"; t << " --></script>\n"; t << " <div id=\"MSearchBox\" class=\"MSearchBoxInactive\">\n"; t << " <div class=\"MSearchBoxRow\"><span class=\"MSearchBoxLeft\">\n"; t << " <a id=\"MSearchClose\" href=\"javascript:searchBox.CloseResultsWindow()\">" << "<img id=\"MSearchCloseImg\" border=\"0\" src=\"search/close.png\" alt=\"\"/></a>\n"; - t << " <input type=\"text\" id=\"MSearchField\" value=\"Search\" accesskey=\"S\"\n"; + t << " <input type=\"text\" id=\"MSearchField\" value=\"" + << theTranslator->trSearch() << "\" accesskey=\"S\"\n"; t << " onfocus=\"searchBox.OnSearchFieldFocus(true)\" \n"; t << " onblur=\"searchBox.OnSearchFieldFocus(false)\" \n"; t << " onkeyup=\"searchBox.OnSearchFieldChange(event)\"/>\n"; diff --git a/src/gifenc.cpp b/src/gifenc.cpp new file mode 100644 index 0000000..501e433 --- /dev/null +++ b/src/gifenc.cpp @@ -0,0 +1,287 @@ +/****************************************************************************** + * + * $Id$ + * + * + * Copyright (C) 1997-2009 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. + * + * All output generated with Doxygen is not covered by this license. + * + * The GIF compression code below is based on the file ppmtogif.c of the + * netpbm package. The original copyright message follows: + * + * --------------------------------------------------------------------------- + * + * Copyright (C) 1989 by Jef Poskanzer. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation for any purpose and without fee is hereby granted, provided + * that the above copyright notice appear in all copies and that both that + * copyright notice and this permission notice appear in supporting + * documentation. This software is provided "as is" without express or + * implied warranty. + * + * --------------------------------------------------------------------------- + * + * The Graphics Interchange Format(c) is the Copyright property of + * CompuServe Incorporated. GIF(sm) is a Service Mark property of + * CompuServe Incorporated. + */ + +#include "gifenc.h" + +static const unsigned int masks[] = { 0x0000, 0x0001, 0x0003, 0x0007, 0x000F, + 0x001F, 0x003F, 0x007F, 0x00FF, + 0x01FF, 0x03FF, 0x07FF, 0x0FFF, + 0x1FFF, 0x3FFF, 0x7FFF, 0xFFFF }; + +GifEncoder::GifEncoder(Byte *rawBytes,Color *p,int w,int h, Byte d, + int t) + : colorResolution(8),globalPaletteFlag(0x80),bits(12), + maxMaxCode(1<<bits) +{ + width = w; + height = h; + depth = d; + transIndex = t; + palette = p; + data = rawBytes; + dataPtr = data; +} + +GifEncoder::~GifEncoder() +{ +} + +void GifEncoder::writeGIF(QFile &fp) +{ + // Write the Magic header + fp.writeBlock( transIndex < 0 ? "GIF87a" : "GIF89a", 6 ); + + // Write the logical screen descriptor + putWord( width, fp ); + putWord( height, fp ); + Byte pack = globalPaletteFlag | ((colorResolution-1)<<4) | (depth-1); + putByte( pack, fp ); + putByte( 0, fp ); // the background color + putByte( 0, fp ); // no aspect ration defined + + // Write global color table + int i; for ( i=0 ; i< (1<<depth) ; i++) + { + putByte(palette[i].red, fp); + putByte(palette[i].green,fp); + putByte(palette[i].blue, fp); + } + + if ( transIndex >= 0) + { + // Write graphic control extension (needed for GIF transparancy) + putByte( 0x21, fp); // extension introducer + putByte( 0xf9, fp); // graphic control label + putByte( 4, fp); // block size + putByte( 1, fp); // announce transparacy value + putWord( 0, fp); // zero delay time + putByte( transIndex, fp); // write transparant index + putByte( 0, fp); // end block + } + + // Write the image descriptor + putByte( 0x2c, fp); // image separator + putWord( 0, fp); // image left position + putWord( 0, fp); // image top position + putWord( width, fp); // image width + putWord( height, fp); // image height + putByte( 0, fp); // no local color table, no interlacing + + // Write table based image data + Byte initCodeSize = depth<=1 ? 2 : depth; + putByte( initCodeSize, fp); // LZW Minimum Code Size + compress( initCodeSize+1, fp); + putByte( 0, fp); // end of blocks + + // Write GIF Trailer + putByte( 0x3b, fp); +} + +void GifEncoder::compress( int ibits, QFile &outfile ) +{ + int i; + int entry; + + initBits = ibits; + numPixels = width*height; + dataPtr = data; + clearFlag = FALSE; + nBits = initBits; + maxCode = (1<<nBits) -1; + ClearCode = (1 << (initBits - 1)); + EOFCode = ClearCode + 1; + freeEntry = ClearCode + 2; + aCount = 0; + curAccum = 0; + curBits = 0; + + entry = nextPixel(); + + int hshift = 0; + int fcode; + for ( fcode = hashTableSize; fcode < 65536L; fcode *= 2L ) ++hshift; + hshift = 8 - hshift; /* set hash code range bound */ + + clearHashTable(); /* clear hash table */ + + writeCode( ClearCode,outfile ); + + int c; + while ( (c = nextPixel()) != EOF ) + { + fcode = (c << bits) + entry; + i = (c << hshift) ^ entry; /* xor hashing */ + + bool found=FALSE; + if (htab[i]==fcode) + { + entry = codetab[i]; + found=TRUE; + } + else if (htab[i]>=0) + { + int disp = hashTableSize - i; + if (i==0) disp=1; + do + { + if ((i-=disp)<0) i+=hashTableSize; + if (htab[i]==fcode) + { + entry=codetab[i]; + found=TRUE; + } + } while (htab[i]>0 && !found); + } + if (!found) + { + writeCode( entry, outfile ); + entry = c; + if ( freeEntry < maxMaxCode ) + { + codetab[i] = freeEntry++; /* code -> hashtable */ + htab[i] = fcode; + } + else + { + clearHashTable(); + freeEntry = ClearCode + 2; + clearFlag = TRUE; + writeCode( ClearCode, outfile ); + } + } + } + writeCode( entry, outfile ); + writeCode( EOFCode, outfile ); +} + +void GifEncoder::putWord( Word w, QFile &fp ) +{ + fp.putch( w & 0xff ); + fp.putch( (w>>8) & 0xff ); +} + +void GifEncoder::putByte( Byte b, QFile &fp ) +{ + fp.putch( b ); +} + +void GifEncoder::writeCode( int code, QFile &outfile ) +{ + curAccum &= masks[ curBits ]; + + if ( curBits > 0 ) + { + curAccum |= (code << curBits); + } + else + { + curAccum = code; + } + + curBits += nBits; + + while( curBits >= 8 ) + { + writeChar( (Byte)(curAccum & 0xff),outfile ); + curAccum >>= 8; + curBits -= 8; + } + + /* + * If the next entry is going to be too big for the code size, + * then increase it, if possible. + */ + if ( freeEntry > maxCode || clearFlag ) + { + if( clearFlag ) + { + nBits = initBits; + maxCode = (1<<nBits)-1; + clearFlag = FALSE; + } + else + { + ++nBits; + if ( nBits == bits ) + maxCode = maxMaxCode; + else + maxCode = (1<<nBits)-1; + } + } + + if ( code == EOFCode ) + { + /* At EOF, write the rest of the buffer. */ + while( curBits > 0 ) + { + writeChar( (Byte)(curAccum & 0xff), outfile ); + curAccum >>= 8; + curBits -= 8; + } + + writePacket(outfile); + } +} + +/* + * Add a character to the end of the current packet, and if it is 254 + * characters, flush the packet to disk. + */ +void GifEncoder::writeChar( Byte c, QFile &fp ) +{ + accum[ aCount++ ] = c; + if( aCount >= 254 ) writePacket(fp); +} + +/* + * Flush the packet to disk, and reset the accumulator + */ +void GifEncoder::writePacket(QFile &fp) +{ + if ( aCount > 0 ) + { + fp.putch( aCount ); + fp.writeBlock( (const char *)accum, aCount ); + aCount = 0; + } +} + +void GifEncoder::clearHashTable() /* reset code table */ +{ + int *htab_p = htab; + int i; for (i=0;i<hashTableSize;i++) *htab_p++ = -1; +} + diff --git a/src/gifenc.h b/src/gifenc.h new file mode 100644 index 0000000..cca3283 --- /dev/null +++ b/src/gifenc.h @@ -0,0 +1,90 @@ +/****************************************************************************** + * + * $Id$ + * + * + * Copyright (C) 1997-2009 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. + * + * All output generated with Doxygen is not covered by this license. + * + */ + +#ifndef _GIFENC_H +#define _GIFENC_H +#include <qfile.h> + +typedef unsigned char Byte; +typedef unsigned short Word; + +struct Color +{ + Byte red; + Byte green; + Byte blue; +}; + +const int hashTableSize=5003; // size of the hash table + +class GifEncoder +{ + public: + GifEncoder(Byte *rawBytes,Color *p,int w,int h,Byte d,int t); + ~GifEncoder(); + void writeGIF(QFile &fp); + + protected: + void putWord( Word w, QFile &fp ); + void putByte( Byte b, QFile &fp ); + void compress(int csize, QFile &fp); + void writeCode(int code, QFile &fp); + void writeChar( Byte c, QFile &fp ); + void writePacket(QFile &fp); + void clearHashTable(); + int nextPixel() + { + if ( --numPixels < 0) return EOF; + return *dataPtr++; + } + + + private: + const int colorResolution; // 8 bit for Red, Green and Blue; + const int globalPaletteFlag; + const int bits; + const int maxMaxCode; + + // image variables + int width; // image width + int height; // image height + Byte depth; // bits per CLUT entry + int transIndex; // index of the transparant color; -1 = none + Color *palette; // pointer to the color palette + int numPixels; // total number of pixel (i.e. width * height) + Byte *data; // pointer to the image data (one byte per pixel) + Byte *dataPtr; // pointer located at the current pixel. + + // compression variables + bool clearFlag; // clear hash table flag + int freeEntry; // first free entry in the hash table + unsigned int curAccum; // encoded bit accumulator + int curBits; // number of bits in curAccum + Byte accum[256]; // Buffer for a packet + int aCount; // Number of characters so far in this 'packet' + int nBits; // number of bits/code + int maxCode; // maximum code, given n_bits + int initBits; // initial number of bits + int EOFCode; // code for signaling the end of the file + int ClearCode; // the clear code for the decompressor + + // tables + int htab[hashTableSize]; // the hash table + Word codetab[hashTableSize]; // the code table +}; + +#endif diff --git a/src/groupdef.cpp b/src/groupdef.cpp index 166acd8..3f3c86f 100644 --- a/src/groupdef.cpp +++ b/src/groupdef.cpp @@ -1300,16 +1300,18 @@ MemberList *GroupDef::getMemberList(MemberList::ListType lt) const void GroupDef::writeMemberDeclarations(OutputList &ol,MemberList::ListType lt,const QCString &title) { - static bool optimizeVhdl = Config_getBool("OPTIMIZE_OUTPUT_VHDL"); - + static bool optimizeVhdl = Config_getBool("OPTIMIZE_OUTPUT_VHDL"); + MemberList * ml = getMemberList(lt); - if (optimizeVhdl && ml) - { - VhdlDocGen::writeVhdlDeclarations(ml,ol,this,0,0); - return; - } + if (optimizeVhdl && ml) + { + VhdlDocGen::writeVhdlDeclarations(ml,ol,this,0,0); + return; + } if (ml) - ml->writeDeclarations(ol,0,0,0,this,title,0); + { + ml->writeDeclarations(ol,0,0,0,this,title,0); + } } void GroupDef::writeMemberDocumentation(OutputList &ol,MemberList::ListType lt,const QCString &title) diff --git a/src/htmldocvisitor.cpp b/src/htmldocvisitor.cpp index f3c3393..fa25951 100644 --- a/src/htmldocvisitor.cpp +++ b/src/htmldocvisitor.cpp @@ -665,6 +665,7 @@ void HtmlDocVisitor::visitPre(DocPara *p) case DocNode::Kind_SimpleListItem: case DocNode::Kind_AutoListItem: case DocNode::Kind_SimpleSect: + case DocNode::Kind_XRefItem: needsTag = TRUE; break; case DocNode::Kind_Root: @@ -741,6 +742,7 @@ void HtmlDocVisitor::visitPost(DocPara *p) case DocNode::Kind_SimpleListItem: case DocNode::Kind_AutoListItem: case DocNode::Kind_SimpleSect: + case DocNode::Kind_XRefItem: needsTag = TRUE; break; case DocNode::Kind_Root: @@ -1506,7 +1508,7 @@ void HtmlDocVisitor::writeDotFile(const QString &fileName,const QString &relPath if ((i=baseName.findRev('/'))!=-1) { baseName=baseName.right(baseName.length()-i-1); - } + } QString outDir = Config_getString("HTML_OUTPUT"); writeDotGraphFromFile(fileName,outDir,baseName,BITMAP); QString mapName = baseName+".map"; @@ -1526,7 +1528,7 @@ void HtmlDocVisitor::writeMscFile(const QString &fileName,const QString &relPath if ((i=baseName.findRev('/'))!=-1) { baseName=baseName.right(baseName.length()-i-1); - } + } QString outDir = Config_getString("HTML_OUTPUT"); writeMscGraphFromFile(fileName,outDir,baseName,MSC_BITMAP); QString mapName = baseName+".map"; @@ -1552,7 +1554,7 @@ void HtmlDocVisitor::forceEndParagraph(DocNode *n) if (nodeIndex<0) return; // first node while (nodeIndex>=0 && para->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace - ) + ) { nodeIndex--; } @@ -1562,7 +1564,7 @@ void HtmlDocVisitor::forceEndParagraph(DocNode *n) //printf("n=%p kind=%d outside=%d\n",n,n->kind(),mustBeOutsideParagraph(n)); if (mustBeOutsideParagraph(n)) return; } - + bool isFirst; bool isLast; getParagraphContext(para,isFirst,isLast); @@ -1589,7 +1591,7 @@ void HtmlDocVisitor::forceStartParagraph(DocNode *n) if (nodeIndex==numNodes) return; // last node while (nodeIndex<numNodes && para->children().at(nodeIndex)->kind()==DocNode::Kind_WhiteSpace - ) + ) { nodeIndex++; } @@ -1608,7 +1610,7 @@ void HtmlDocVisitor::forceStartParagraph(DocNode *n) getParagraphContext(para,isFirst,isLast); //printf("forceStart first=%d last=%d\n",isFirst,isLast); if (isFirst && isLast) return; - + m_t << "<p>"; } } diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp index 74bea86..66d3ea4 100644 --- a/src/htmlgen.cpp +++ b/src/htmlgen.cpp @@ -825,7 +825,7 @@ void HtmlGenerator::startFile(const char *name,const char *, { t << "<script type=\"text/javascript\"><!--\n"; t << "var searchBox = new SearchBox(\"searchBox\", \"" - << relPath<< "search\",false);\n"; + << relPath<< "search\",false,'" << theTranslator->trSearch() << "');\n"; t << "--></script>\n"; } generateDynamicSections(t,relPath); @@ -1294,17 +1294,19 @@ void HtmlGenerator::endClassDiagram(const ClassDiagram &d, { t << "</div>" << endl; t << "<div class=\"dynsection\">" << endl; - t << "<img class=\"center\" src=\""; - t << relPath << fileName << ".png\" usemap=\"#"; + t << " <div class=\"center\">" << endl; + t << " <img src=\""; + t << relPath << fileName << ".gif\" usemap=\"#"; docify(name); t << "_map\" alt=\"\"/>" << endl; - t << "<map id=\""; + t << " <map id=\""; docify(name); t << "_map\" name=\""; docify(name); t << "_map\">" << endl; d.writeImage(t,dir,relPath,fileName); + t << " </div>" << endl; t << "</div>" << endl; } @@ -2027,7 +2029,8 @@ static void renderQuickLinksAsTabs(QTextStream &t,const QCString &relPath, t << " onmouseover=\"return searchBox.OnSearchSelectShow()\"\n"; t << " onmouseout=\"return searchBox.OnSearchSelectHide()\"\n"; t << " alt=\"\"/>\n"; - t << " <input type=\"text\" id=\"MSearchField\" value=\"Search\" accesskey=\"S\"\n"; + t << " <input type=\"text\" id=\"MSearchField\" value=\"" + << theTranslator->trSearch() << "\" accesskey=\"S\"\n"; t << " onfocus=\"searchBox.OnSearchFieldFocus(true)\" \n"; t << " onblur=\"searchBox.OnSearchFieldFocus(false)\" \n"; t << " onkeyup=\"searchBox.OnSearchFieldChange(event)\"/>\n"; diff --git a/src/image.cpp b/src/image.cpp index c2d79d5..e290e1b 100644 --- a/src/image.cpp +++ b/src/image.cpp @@ -18,8 +18,8 @@ #include "qtbc.h" #include "image.h" -#include "pngenc.h" -#include <qglobal.h> +#include "gifenc.h" +#include <qfile.h> const int charSetWidth=80; const int charHeight=12; @@ -321,11 +321,20 @@ void Image::fillRect(int x,int y,int lwidth,int lheight,uchar colIndex,uint mask bool Image::save(const char *fileName,int mode) { - PngEncoder enc(data, - mode==0 ? palette : palette2, - width,height, - mode==0 ? 3 : 4, - 0); - enc.write(fileName); - return TRUE; + GifEncoder gifenc(data, + mode==0 ? palette : palette2, + width,height, + mode==0 ? 3 : 4, + 0); + QFile file(fileName); + if (file.open(IO_WriteOnly)) + { + gifenc.writeGIF(file); + return TRUE; + } + else + { + return FALSE; + } } + diff --git a/src/index.cpp b/src/index.cpp index ff59003..39171a2 100644 --- a/src/index.cpp +++ b/src/index.cpp @@ -2293,8 +2293,9 @@ static void addMemberToSearchIndex( } } else if (isLinkable && - ((nd=md->getNamespaceDef()) && nd->isLinkable()) || - ((fd=md->getFileDef()) && fd->isLinkable()) + (((nd=md->getNamespaceDef()) && nd->isLinkable()) || + ((fd=md->getFileDef()) && fd->isLinkable()) + ) ) { QCString n = md->name(); @@ -2527,8 +2528,7 @@ void writeSearchIndex() t << "</head>" << endl; t << "<body class=\"SRPage\">" << endl; t << "<div id=\"SRIndex\">" << endl; - // TODO: translate "Loading" - t << "<div class=\"SRStatus\" id=\"Loading\">Loading...</div>" << endl; + t << "<div class=\"SRStatus\" id=\"Loading\">" << theTranslator->trLoading() << "</div>" << endl; SDict<QList<Definition> >::Iterator li(g_searchIndexSymbols[i][p]); QList<Definition> *dl; @@ -2552,9 +2552,6 @@ void writeSearchIndex() << "return searchResults.Nav(event," << itemCount << ")\" " << "onkeyup=\"" << "return searchResults.Nav(event," << itemCount << ")\" " - // << "onkeydown=\"return true\" " - // << "onkeypress=\"" - // << "return searchResults.Nav(event," << itemCount << ")\" " << "class=\"SRSymbol\" href=\"../" << d->getOutputFileBase() << Doxygen::htmlFileExtension; if (isMemberDef) @@ -2593,9 +2590,6 @@ void writeSearchIndex() << "return searchResults.Nav(event," << itemCount << ")\" " << "onkeyup=\"" << "return searchResults.Nav(event," << itemCount << ")\" " - // << "onkeydown=\"return true\" " - // << "onkeypress=\"" - // << "return searchResults.Nav(event," << itemCount << ")\" " << "class=\"SRSymbol\" " << "href=\"javascript:searchResults.Toggle('SR_" << searchId(d->localName()) << "')\">" @@ -2628,10 +2622,6 @@ void writeSearchIndex() << "onkeyup=\"" << "return searchResults.NavChild(event," << itemCount << "," << childCount << ")\" " - // << "onkeydown=\"return true\" " - // << "onkeypress=\"" - // << "return searchResults.NavChild(event," - // << itemCount << "," << childCount << ")\" " << "class=\"SRScope\" href=\"../" << d->getOutputFileBase() << Doxygen::htmlFileExtension; if (isMemberDef) @@ -2696,8 +2686,7 @@ void writeSearchIndex() } if (!found) // fallback { - // TODO: translate "global namespace" - t << prefix << "(global namespace)"; + t << prefix << "("+theTranslator->trGlobalNamespace()+")"; } t << "</a>" << endl; prevScope = scope; @@ -2709,10 +2698,10 @@ void writeSearchIndex() t << "</div>" << endl; // SRResult itemCount++; } - // TODO: translate "Searching" - t << "<div class=\"SRStatus\" id=\"Searching\">Searching...</div>" << endl; - // TODO: translate "No Matches" - t << "<div class=\"SRStatus\" id=\"NoMatches\">No Matches</div>" << endl; + t << "<div class=\"SRStatus\" id=\"Searching\">" + << theTranslator->trSearching() << "</div>" << endl; + t << "<div class=\"SRStatus\" id=\"NoMatches\">" + << theTranslator->trNoMatches() << "</div>" << endl; t << "<script type=\"text/javascript\"><!--" << endl; t << "document.getElementById(\"Loading\").style.display=\"none\";" << endl; @@ -2807,8 +2796,8 @@ void writeSearchIndex() t << "</head>" << endl; t << "<body class=\"SRPage\">" << endl; t << "<div id=\"SRIndex\">" << endl; - // TODO: translate "No Matches" - t << "<div class=\"SRStatus\" id=\"NoMatches\">No Matches</div>" << endl; + t << "<div class=\"SRStatus\" id=\"NoMatches\">" + << theTranslator->trNoMatches() << "</div>" << endl; t << "</div>" << endl; t << "</body>" << endl; t << "</html>" << endl; diff --git a/src/latexdocvisitor.cpp b/src/latexdocvisitor.cpp index e0831b9..e4c619a 100644 --- a/src/latexdocvisitor.cpp +++ b/src/latexdocvisitor.cpp @@ -233,13 +233,13 @@ void LatexDocVisitor::visit(DocStyleChange *s) switch (s->style()) { case DocStyleChange::Bold: - if (s->enable()) m_t << "{\\bf "; else m_t << "}"; + if (s->enable()) m_t << "{\\bfseries "; else m_t << "}"; break; case DocStyleChange::Italic: - if (s->enable()) m_t << "{\\em "; else m_t << "\\/}"; + if (s->enable()) m_t << "{\\itshape "; else m_t << "\\/}"; break; case DocStyleChange::Code: - if (s->enable()) m_t << "{\\tt "; else m_t << "}"; + if (s->enable()) m_t << "{\\ttfamily "; else m_t << "}"; break; case DocStyleChange::Subscript: if (s->enable()) m_t << "$_{\\mbox{"; else m_t << "}}$ "; @@ -256,13 +256,13 @@ void LatexDocVisitor::visit(DocStyleChange *s) case DocStyleChange::Preformatted: if (s->enable()) { - m_t << "\\small\\begin{alltt}"; + m_t << "\n\\begin{DoxyPre}"; m_insidePre=TRUE; } else { m_insidePre=FALSE; - m_t << "\\end{alltt}\n\\normalsize " << endl; + m_t << "\\end{DoxyPre}\n"; } break; case DocStyleChange::Div: /* HTML only */ break; @@ -283,7 +283,7 @@ void LatexDocVisitor::visit(DocVerbatim *s) } else { - m_t << "\n\n\\begin{Code}\\begin{verbatim}"; + m_t << "\n\\begin{DoxyCode}\n"; } Doxygen::parserManager->getParser(m_langExt) ->parseCode(m_ci,s->context(),s->text().latin1(), @@ -294,13 +294,13 @@ void LatexDocVisitor::visit(DocVerbatim *s) } else { - m_t << "\\end{verbatim}\n\\end{Code}\n" << endl; + m_t << "\\end{DoxyCode}\n"; } break; case DocVerbatim::Verbatim: - m_t << "\n\n\\begin{footnotesize}\\begin{verbatim}"; + m_t << "\\begin{DoxyVerb}"; m_t << s->text(); - m_t << "\\end{verbatim}\n\\end{footnotesize}" << endl; + m_t << "\\end{DoxyVerb}\n"; break; case DocVerbatim::HtmlOnly: case DocVerbatim::XmlOnly: @@ -384,7 +384,7 @@ void LatexDocVisitor::visit(DocInclude *inc) { case DocInclude::IncWithLines: { - m_t << "\n\n\\begin{DocInclude}\\begin{verbatim}"; + m_t << "\n\\begin{DoxyCodeInclude}\n"; QFileInfo cfi( inc->file() ); FileDef fd( cfi.dirPath(), cfi.fileName() ); Doxygen::parserManager->getParser(inc->extension()) @@ -392,25 +392,25 @@ void LatexDocVisitor::visit(DocInclude *inc) inc->text().latin1(), inc->isExample(), inc->exampleFile(), &fd); - m_t << "\\end{verbatim}\n\\end{DocInclude}" << endl; + m_t << "\\end{DoxyCodeInclude}" << endl; } break; case DocInclude::Include: - m_t << "\n\n\\begin{DocInclude}\\begin{verbatim}"; + m_t << "\n\\begin{DoxyCodeInclude}\n"; Doxygen::parserManager->getParser(inc->extension()) ->parseCode(m_ci,inc->context(), inc->text().latin1(),inc->isExample(), inc->exampleFile()); - m_t << "\\end{verbatim}\n\\end{DocInclude}" << endl; + m_t << "\\end{DoxyCodeInclude}\n"; break; case DocInclude::DontInclude: break; case DocInclude::HtmlInclude: break; case DocInclude::VerbInclude: - m_t << "\n\n\\begin{VerbInclude}\\begin{verbatim}"; + m_t << "\n\\begin{DoxyVerbInclude}\n"; m_t << inc->text(); - m_t << "\\end{verbatim}\n\\end{VerbInclude}" << endl; + m_t << "\\end{DoxyVerbInclude}\n"; break; } } @@ -421,7 +421,7 @@ void LatexDocVisitor::visit(DocIncOperator *op) // op->type(),op->isFirst(),op->isLast(),op->text().data()); if (op->isFirst()) { - if (!m_hide) m_t << "\n\n\\begin{DocInclude}\\begin{verbatim}"; + if (!m_hide) m_t << "\n\\begin{DoxyCodeInclude}\n"; pushEnabled(); m_hide = TRUE; } @@ -440,7 +440,7 @@ void LatexDocVisitor::visit(DocIncOperator *op) if (op->isLast()) { popEnabled(); - if (!m_hide) m_t << "\\end{verbatim}\n\\end{DocInclude}" << endl; + if (!m_hide) m_t << "\n\\end{DoxyCodeInclude}\n"; } else { @@ -475,11 +475,11 @@ void LatexDocVisitor::visitPre(DocAutoList *l) if (m_hide) return; if (l->isEnumList()) { - m_t << "\\begin{enumerate}" << endl; + m_t << "\n\\begin{DoxyEnumerate}"; } else { - m_t << "\\begin{itemize}" << endl; + m_t << "\n\\begin{DoxyItemize}"; } } @@ -488,18 +488,18 @@ void LatexDocVisitor::visitPost(DocAutoList *l) if (m_hide) return; if (l->isEnumList()) { - m_t << "\\end{enumerate}" << endl; + m_t << "\n\\end{DoxyEnumerate}"; } else { - m_t << "\\end{itemize}" << endl; + m_t << "\n\\end{DoxyItemize}"; } } void LatexDocVisitor::visitPre(DocAutoListItem *) { if (m_hide) return; - m_t << "\\item "; + m_t << "\n\\item "; } void LatexDocVisitor::visitPost(DocAutoListItem *) @@ -531,38 +531,67 @@ void LatexDocVisitor::visitPost(DocRoot *) void LatexDocVisitor::visitPre(DocSimpleSect *s) { if (m_hide) return; - m_t << "\\begin{Desc}\n\\item["; switch(s->type()) { - case DocSimpleSect::See: - filter(theTranslator->trSeeAlso()); break; - case DocSimpleSect::Return: - filter(theTranslator->trReturns()); break; - case DocSimpleSect::Author: - filter(theTranslator->trAuthor(TRUE,TRUE)); break; - case DocSimpleSect::Authors: - filter(theTranslator->trAuthor(TRUE,FALSE)); break; - case DocSimpleSect::Version: - filter(theTranslator->trVersion()); break; - case DocSimpleSect::Since: - filter(theTranslator->trSince()); break; - case DocSimpleSect::Date: - filter(theTranslator->trDate()); break; - case DocSimpleSect::Note: - filter(theTranslator->trNote()); break; + case DocSimpleSect::See: + m_t << "\\begin{DoxySeeAlso}{"; + filter(theTranslator->trSeeAlso()); + break; + case DocSimpleSect::Return: + m_t << "\\begin{DoxyReturn}{"; + filter(theTranslator->trReturns()); + break; + case DocSimpleSect::Author: + m_t << "\\begin{DoxyAuthor}{"; + filter(theTranslator->trAuthor(TRUE,TRUE)); + break; + case DocSimpleSect::Authors: + m_t << "\\begin{DoxyAuthor}{"; + filter(theTranslator->trAuthor(TRUE,FALSE)); + break; + case DocSimpleSect::Version: + m_t << "\\begin{DoxyVersion}{"; + filter(theTranslator->trVersion()); + break; + case DocSimpleSect::Since: + m_t << "\\begin{DoxySince}{"; + filter(theTranslator->trSince()); + break; + case DocSimpleSect::Date: + m_t << "\\begin{DoxyDate}{"; + filter(theTranslator->trDate()); + break; + case DocSimpleSect::Note: + m_t << "\\begin{DoxyNote}{"; + filter(theTranslator->trNote()); + break; case DocSimpleSect::Warning: - filter(theTranslator->trWarning()); break; + m_t << "\\begin{DoxyWarning}{"; + filter(theTranslator->trWarning()); + break; case DocSimpleSect::Pre: - filter(theTranslator->trPrecondition()); break; + m_t << "\\begin{DoxyPrecond}{"; + filter(theTranslator->trPrecondition()); + break; case DocSimpleSect::Post: - filter(theTranslator->trPostcondition()); break; + m_t << "\\begin{DoxyPostcond}{"; + filter(theTranslator->trPostcondition()); + break; case DocSimpleSect::Invar: - filter(theTranslator->trInvariant()); break; + m_t << "\\begin{DoxyInvariant}{"; + filter(theTranslator->trInvariant()); + break; case DocSimpleSect::Remark: - filter(theTranslator->trRemarks()); break; + m_t << "\\begin{DoxyRemark}{"; + filter(theTranslator->trRemarks()); + break; case DocSimpleSect::Attention: - filter(theTranslator->trAttention()); break; - case DocSimpleSect::User: break; + m_t << "\\begin{DoxyAttention}{"; + filter(theTranslator->trAttention()); + break; + case DocSimpleSect::User: + m_t << "\\begin{DoxyParagraph}{"; + break; case DocSimpleSect::Rcs: break; case DocSimpleSect::Unknown: break; } @@ -570,7 +599,7 @@ void LatexDocVisitor::visitPre(DocSimpleSect *s) // special case 1: user defined title if (s->type()!=DocSimpleSect::User && s->type()!=DocSimpleSect::Rcs) { - m_t << ":]"; + m_t << "}\n"; } else { @@ -578,10 +607,59 @@ void LatexDocVisitor::visitPre(DocSimpleSect *s) } } -void LatexDocVisitor::visitPost(DocSimpleSect *) +void LatexDocVisitor::visitPost(DocSimpleSect *s) { if (m_hide) return; - m_t << "\\end{Desc}" << endl; + switch(s->type()) + { + case DocSimpleSect::See: + m_t << "\n\\end{DoxySeeAlso}\n"; + break; + case DocSimpleSect::Return: + m_t << "\n\\end{DoxyReturn}\n"; + break; + case DocSimpleSect::Author: + m_t << "\n\\end{DoxyAuthor}\n"; + break; + case DocSimpleSect::Authors: + m_t << "\n\\end{DoxyAuthor}\n"; + break; + case DocSimpleSect::Version: + m_t << "\n\\end{DoxyVersion}\n"; + break; + case DocSimpleSect::Since: + m_t << "\n\\end{DoxySince}\n"; + break; + case DocSimpleSect::Date: + m_t << "\n\\end{DoxyDate}\n"; + break; + case DocSimpleSect::Note: + m_t << "\n\\end{DoxyNote}\n"; + break; + case DocSimpleSect::Warning: + m_t << "\n\\end{DoxyWarning}\n"; + break; + case DocSimpleSect::Pre: + m_t << "\n\\end{DoxyPrecond}\n"; + break; + case DocSimpleSect::Post: + m_t << "\n\\end{DoxyPostcond}\n"; + break; + case DocSimpleSect::Invar: + m_t << "\n\\end{DoxyInvariant}\n"; + break; + case DocSimpleSect::Remark: + m_t << "\n\\end{DoxyRemark}\n"; + break; + case DocSimpleSect::Attention: + m_t << "\n\\end{DoxyAttention}\n"; + break; + case DocSimpleSect::User: + m_t << "\n\\end{DoxyParagraph}\n"; + break; + default: + break; + } } void LatexDocVisitor::visitPre(DocTitle *) @@ -592,19 +670,19 @@ void LatexDocVisitor::visitPost(DocTitle *) { if (m_hide) return; m_insideItem=FALSE; - m_t << "]"; + m_t << "}\n"; } void LatexDocVisitor::visitPre(DocSimpleList *) { if (m_hide) return; - m_t << "\\begin{itemize}" << endl; + m_t << "\\begin{DoxyItemize}" << endl; } void LatexDocVisitor::visitPost(DocSimpleList *) { if (m_hide) return; - m_t << "\\end{itemize}" << endl; + m_t << "\\end{DoxyItemize}" << endl; } void LatexDocVisitor::visitPre(DocSimpleListItem *) @@ -637,24 +715,24 @@ void LatexDocVisitor::visitPre(DocHtmlList *s) { if (m_hide) return; if (s->type()==DocHtmlList::Ordered) - m_t << "\\begin{enumerate}" << endl; + m_t << "\n\\begin{DoxyEnumerate}"; else - m_t << "\\begin{itemize}" << endl; + m_t << "\n\\begin{DoxyItemize}"; } void LatexDocVisitor::visitPost(DocHtmlList *s) { if (m_hide) return; if (s->type()==DocHtmlList::Ordered) - m_t << "\\end{enumerate}" << endl; + m_t << "\n\\end{DoxyEnumerate}"; else - m_t << "\\end{itemize}" << endl; + m_t << "\n\\end{DoxyItemize}"; } void LatexDocVisitor::visitPre(DocHtmlListItem *) { if (m_hide) return; - m_t << "\\item "; + m_t << "\n\\item "; } void LatexDocVisitor::visitPost(DocHtmlListItem *) @@ -676,19 +754,19 @@ void LatexDocVisitor::visitPost(DocHtmlListItem *) void LatexDocVisitor::visitPre(DocHtmlDescList *) { if (m_hide) return; - m_t << "\\begin{description}" << endl; + m_t << "\n\\begin{DoxyDescription}"; } void LatexDocVisitor::visitPost(DocHtmlDescList *) { if (m_hide) return; - m_t << "\\end{description}" << endl; + m_t << "\n\\end{DoxyDescription}"; } void LatexDocVisitor::visitPre(DocHtmlDescTitle *) { if (m_hide) return; - m_t << "\\item["; + m_t << "\n\\item["; m_insideItem=TRUE; } @@ -810,14 +888,15 @@ void LatexDocVisitor::visitPost(DocHtmlCell *c) void LatexDocVisitor::visitPre(DocInternal *) { if (m_hide) return; - m_t << "\\begin{Desc}" << endl - << "\\item["; filter(theTranslator->trForInternalUseOnly()); m_t << "]" << endl; + m_t << "\\begin{DoxyInternal}{"; + filter(theTranslator->trForInternalUseOnly()); + m_t << "}\n"; } void LatexDocVisitor::visitPost(DocInternal *) { if (m_hide) return; - m_t << "\\end{Desc}" << endl; + m_t << "\\end{DoxyInternal}" << endl; } void LatexDocVisitor::visitPre(DocHRef *href) @@ -857,12 +936,12 @@ void LatexDocVisitor::visitPre(DocImage *img) if (m_hide) return; if (img->hasCaption()) { - m_t << "\\begin{Image}" << endl; - m_t << "\\begin{center}" << endl; + m_t << "\n\\begin{DoxyImage}\n"; } else { - m_t << "\\begin{ImageNoCaption}\\mbox{"; + m_t << "\n\\begin{DoxyImageNoCaption}\n" + " \\mbox{"; } QString gfxName = img->name(); if (gfxName.right(4)==".eps" || gfxName.right(4)==".pdf") @@ -881,7 +960,7 @@ void LatexDocVisitor::visitPre(DocImage *img) m_t << "{" << gfxName << "}"; if (img->hasCaption()) { - m_t << "\\caption{"; + m_t << "\n\\caption{"; } } else // other format -> skip @@ -896,14 +975,13 @@ void LatexDocVisitor::visitPost(DocImage *img) if (img->type()==DocImage::Latex) { if (m_hide) return; - m_t << "}" << endl; // end mbox or caption + m_t << "}\n"; // end mbox or caption if (img->hasCaption()) { - m_t << "\\end{center}" << endl; - m_t << "\\end{Image}" << endl; + m_t << "\\end{DoxyImage}\n"; } else{ - m_t << "\\end{ImageNoCaption}" << endl; + m_t << "\\end{DoxyImageNoCaption}\n"; } } else // other format @@ -966,13 +1044,13 @@ void LatexDocVisitor::visitPre(DocSecRefList *) if (m_hide) return; m_t << "\\footnotesize" << endl; m_t << "\\begin{multicols}{2}" << endl; - m_t << "\\begin{CompactList}" << endl; + m_t << "\\begin{DoxyCompactList}" << endl; } void LatexDocVisitor::visitPost(DocSecRefList *) { if (m_hide) return; - m_t << "\\end{CompactList}" << endl; + m_t << "\\end{DoxyCompactList}" << endl; m_t << "\\end{multicols}" << endl; m_t << "\\normalsize" << endl; } @@ -999,33 +1077,53 @@ void LatexDocVisitor::visitPost(DocSecRefList *) void LatexDocVisitor::visitPre(DocParamSect *s) { if (m_hide) return; - m_t << "\\begin{Desc}" << endl; - m_t << "\\item["; switch(s->type()) { - case DocParamSect::Param: - filter(theTranslator->trParameters()); break; - case DocParamSect::RetVal: - filter(theTranslator->trReturnValues()); break; + case DocParamSect::Param: + m_t << "\n\\begin{DoxyParams}{"; + filter(theTranslator->trParameters()); + break; + case DocParamSect::RetVal: + m_t << "\n\\begin{DoxyRetVals}{"; + filter(theTranslator->trReturnValues()); + break; case DocParamSect::Exception: - filter(theTranslator->trExceptions()); break; + m_t << "\n\\begin{DoxyExceptions}{"; + filter(theTranslator->trExceptions()); + break; case DocParamSect::TemplateParam: /* TODO: add this filter(theTranslator->trTemplateParam()); break; */ - filter("Template Parameters"); break; + m_t << "\n\\begin{DoxyTemplParams}{"; + filter("Template Parameters"); + break; default: ASSERT(0); } - m_t << ":]" << endl; - m_t << "\\begin{description}" << endl; + m_t << "}\n"; } -void LatexDocVisitor::visitPost(DocParamSect *) +void LatexDocVisitor::visitPost(DocParamSect *s) { if (m_hide) return; - m_t << "\\end{description}" << endl; - m_t << "\\end{Desc}" << endl; + switch(s->type()) + { + case DocParamSect::Param: + m_t << "\\end{DoxyParams}\n"; + break; + case DocParamSect::RetVal: + m_t << "\\end{DoxyRetVals}\n"; + break; + case DocParamSect::Exception: + m_t << "\\end{DoxyExceptions}\n"; + break; + case DocParamSect::TemplateParam: + m_t << "\\end{DoxyTemplParams}\n"; + break; + default: + ASSERT(0); + } } void LatexDocVisitor::visitPre(DocParamList *pl) @@ -1217,12 +1315,12 @@ void LatexDocVisitor::startDotFile(const QString &fileName, writeDotGraphFromFile(name,outDir,baseName,EPS); if (hasCaption) { - m_t << "\\begin{Image}" << endl; - m_t << "\\begin{center}" << endl; + m_t << "\n\\begin{DoxyImage}\n"; } else { - m_t << "\\begin{ImageNoCaption}\\mbox{"; + m_t << "\n\\begin{DoxyImageNoCaption}\n" + " \\mbox{"; } m_t << "\\includegraphics"; if (!width.isEmpty()) @@ -1237,22 +1335,21 @@ void LatexDocVisitor::startDotFile(const QString &fileName, if (hasCaption) { - m_t << "\\caption{"; + m_t << "\n\\caption{"; } } void LatexDocVisitor::endDotFile(bool hasCaption) { if (m_hide) return; - m_t << "}" << endl; // end caption or mbox + m_t << "}\n"; // end caption or mbox if (hasCaption) { - m_t << "\\end{center}" << endl; - m_t << "\\end{Image}" << endl; + m_t << "\\end{DoxyImage}\n"; } else { - m_t << "\\end{ImageNoCaption}" << endl; + m_t << "\\end{DoxyImageNoCaption}\n"; } } @@ -1260,8 +1357,8 @@ void LatexDocVisitor::writeMscFile(const QString &baseName) { QString outDir = Config_getString("LATEX_OUTPUT"); writeMscGraphFromFile(baseName,outDir,baseName,MSC_EPS); - m_t << "\\begin{ImageNoCaption}\\mbox{"; - m_t << "\\includegraphics"; + m_t << "\n\\begin{DoxyImageNoCaption}" + " \\mbox{\\includegraphics"; //if (!width.isEmpty()) //{ // m_t << "[width=" << width << "]"; @@ -1272,7 +1369,7 @@ void LatexDocVisitor::writeMscFile(const QString &baseName) //} m_t << "{" << baseName << "}"; - m_t << "}" << endl; // end mbox - m_t << "\\end{ImageNoCaption}" << endl; + m_t << "}\n"; // end mbox + m_t << "\\end{DoxyImageNoCaption}\n"; } diff --git a/src/latexgen.cpp b/src/latexgen.cpp index b76c7e2..794ef9f 100644 --- a/src/latexgen.cpp +++ b/src/latexgen.cpp @@ -184,7 +184,6 @@ static void writeDefaultHeaderPart1(QTextStream &t) t << "}\n"; if (paperType=="a4wide") t << "\\usepackage{a4wide}\n"; t << "\\usepackage{makeidx}\n" - "\\usepackage{fancyhdr}\n" "\\usepackage{graphicx}\n" "\\usepackage{multicol}\n" "\\usepackage{float}\n" @@ -300,50 +299,263 @@ static void writeDefaultHeaderPart3(QTextStream &t) static void writeDefaultStyleSheetPart1(QTextStream &t) { // part 1 - t << "\\NeedsTeXFormat{LaTeX2e}\n"; - t << "\\ProvidesPackage{doxygen}\n"; - t << "\\RequirePackage{calc}\n"; - t << "\\RequirePackage{array}\n"; - t << "\\RequirePackage{color}\n"; - t << "\\pagestyle{fancyplain}\n"; - //t << "\\addtolength{\\headwidth}{\\marginparsep}\n"; - //t << "\\addtolength{\\headwidth}{\\marginparwidth}\n"; - t << "\\newcommand{\\clearemptydoublepage}{\\newpage{\\pagestyle{empty}"; - t << "\\cleardoublepage}}\n"; + t << "\\NeedsTeXFormat{LaTeX2e}\n" + "\\ProvidesPackage{doxygen}\n\n"; + t << "% Packages used by this style file\n" + "\\RequirePackage{alltt}\n" + "\\RequirePackage{array}\n" + "\\RequirePackage{calc}\n" + "\\RequirePackage{color}\n" + "\\RequirePackage{fancyhdr}\n" + "\\RequirePackage{verbatim}\n\n"; + t << "% Setup fancy headings\n" + "\\pagestyle{fancyplain}\n" + "\\newcommand{\\clearemptydoublepage}{%\n" + " \\newpage{\\pagestyle{empty}\\cleardoublepage}%\n" + "}\n"; if (!Config_getBool("COMPACT_LATEX")) - t << "\\renewcommand{\\chaptermark}[1]{\\markboth{#1}{}}\n"; - t << "\\renewcommand{\\sectionmark}[1]{\\markright{\\thesection\\ #1}}\n"; - t << "\\lhead[\\fancyplain{}{\\bfseries\\thepage}]\n"; - t << " {\\fancyplain{}{\\bfseries\\rightmark}}\n"; - t << "\\rhead[\\fancyplain{}{\\bfseries\\leftmark}]\n"; - t << " {\\fancyplain{}{\\bfseries\\thepage}}\n"; - t << "\\rfoot[\\fancyplain{}{\\bfseries\\scriptsize "; + t << "\\renewcommand{\\chaptermark}[1]{%\n" + " \\markboth{#1}{}%\n" + "}\n"; + t << "\\renewcommand{\\sectionmark}[1]{%\n" + " \\markright{\\thesection\\ #1}%\n" + "}\n"; + t << "\\lhead[\\fancyplain{}{\\bfseries\\thepage}]{%\n" + " \\fancyplain{}{\\bfseries\\rightmark}%\n" + "}\n"; + t << "\\rhead[\\fancyplain{}{\\bfseries\\leftmark}]{%\n" + " \\fancyplain{}{\\bfseries\\thepage}%\n" + "}\n"; + t << "\\rfoot[\\fancyplain{}{\\bfseries\\scriptsize%\n "; } static void writeDefaultStyleSheetPart2(QTextStream &t) { - t << "\\lfoot[]{\\fancyplain{}{\\bfseries\\scriptsize "; + t << "\\lfoot[]{\\fancyplain{}{\\bfseries\\scriptsize%\n "; } static void writeDefaultStyleSheetPart3(QTextStream &t) { t << "}}\n"; - t << "\\cfoot{}\n"; - t << "\\newenvironment{Code}\n"; - t << "{\\footnotesize}\n"; - t << "{\\normalsize}\n"; + t << "\\cfoot{}\n\n"; + t << "%---------- Internal commands used in this style file ----------------\n\n"; + t << "% Generic environment used by all paragraph-based environments defined\n" + "% below. Note that the command \\title{...} needs to be defined inside\n" + "% those environments!\n" + "\\newenvironment{DoxyDesc}[1]{%\n" + " \\begin{list}{}%\n" + " {%\n" + " \\settowidth{\\labelwidth}{40pt}%\n" + " \\setlength{\\leftmargin}{\\labelwidth}%\n" + " \\setlength{\\parsep}{0pt}%\n" + " \\setlength{\\itemsep}{-4pt}%\n" + " \\renewcommand{\\makelabel}{\\entrylabel}%\n" + " }%\n" + " \\item[#1:]%\n" + "}{%\n" + " \\end{list}%\n" + "}\n\n"; + t << "%---------- Commands used by doxygen LaTeX output generator ----------\n\n"; + t << "% Used by <pre> ... </pre>\n" + "\\newenvironment{DoxyPre}{%\n" + " \\small%\n" + " \\begin{alltt}%\n" + "}{%\n" + " \\end{alltt}%\n" + " \\normalsize%\n" + "}\n\n"; + t << "% Used by @code ... @endcode\n" + "\\newenvironment{DoxyCode}{%\n" + " \\footnotesize%\n" + " \\verbatim%\n" + "}{%\n" + " \\endverbatim%\n" + " \\normalsize%\n" + "}\n\n"; + t << "% Used by @example, @include, @includelineno and @dontinclude\n" + "\\newenvironment{DoxyCodeInclude}{%\n" + " \\DoxyCode%\n" + "}{%\n" + " \\endDoxyCode%\n" + "}\n\n"; + t << "% Used by @verbatim ... @endverbatim\n" + "\\newenvironment{DoxyVerb}{%\n" + " \\footnotesize%\n" + " \\verbatim%\n" + "}{%\n" + " \\endverbatim%\n" + " \\normalsize%\n" + "}\n\n"; + t << "% Used by @verbinclude\n" + "\\newenvironment{DoxyVerbInclude}{%\n" + " \\DoxyVerb%\n" + "}{%\n" + " \\endDoxyVerb%\n" + "}\n\n"; + t << "% Used by numbered lists (using '-#' or <ol> ... </ol>)\n" + "\\newenvironment{DoxyEnumerate}{%\n" + " \\enumerate%\n" + "}{%\n" + " \\endenumerate%\n" + "}\n\n"; + t << "% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)\n" + "\\newenvironment{DoxyItemize}{%\n" + " \\itemize%\n" + "}{%\n" + " \\enditemize%\n" + "}\n\n"; + t << "% Used by description lists (using <dl> ... </dl>)\n" + "\\newenvironment{DoxyDescription}{%\n" + " \\description%\n" + "}{%\n" + " \\enddescription%\n" + "}\n\n"; + t << "% Used by @image, @dotfile, and @dot ... @enddot\n" + "% (only if caption is specified)\n" + "\\newenvironment{DoxyImage}{%\n" + " \\begin{figure}[H]%\n" + " \\begin{center}%\n" + "}{%\n" + " \\end{center}%\n" + " \\end{figure}%\n" + "}\n\n"; + t << "% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc\n" + "% (only if no caption is specified)\n" + "\\newenvironment{DoxyImageNoCaption}{%\n" + "}{%\n" + "}\n\n"; + t << "% Used by @attention\n" + "\\newenvironment{DoxyAttention}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @author and @authors\n" + "\\newenvironment{DoxyAuthor}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @date\n" + "\\newenvironment{DoxyDate}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @invariant\n" + "\\newenvironment{DoxyInvariant}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @note\n" + "\\newenvironment{DoxyNote}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @post\n" + "\\newenvironment{DoxyPostcond}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @pre\n" + "\\newenvironment{DoxyPrecond}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @remark\n" + "\\newenvironment{DoxyRemark}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @return\n" + "\\newenvironment{DoxyReturn}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @since\n" + "\\newenvironment{DoxySince}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @see\n" + "\\newenvironment{DoxySeeAlso}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @version\n" + "\\newenvironment{DoxyVersion}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @warning\n" + "\\newenvironment{DoxyWarning}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @internal\n" + "\\newenvironment{DoxyInternal}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + "}{%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by @par and @paragraph\n" + "\\newenvironment{DoxyParagraph}[1]{%\n" + " \\begin{list}{}%\n" + " {%\n" + " \\settowidth{\\labelwidth}{40pt}%\n" + " \\setlength{\\leftmargin}{\\labelwidth}%\n" + " \\setlength{\\parsep}{0pt}%\n" + " \\setlength{\\itemsep}{-4pt}%\n" + " \\renewcommand{\\makelabel}{\\entrylabel}%\n" + " }%\n" + " \\item[#1]%\n" + "}{%\n" + " \\end{list}%\n" + "}\n\n"; + t << "% Used by parameter lists\n" + "\\newenvironment{DoxyParams}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + " \\begin{description}%\n" + "}{%\n" + " \\end{description}%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by return value lists\n" + "\\newenvironment{DoxyRetVals}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + " \\begin{description}%\n" + "}{%\n" + " \\end{description}%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by exception lists\n" + "\\newenvironment{DoxyExceptions}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + " \\begin{description}%\n" + "}{%\n" + " \\end{description}%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; + t << "% Used by template parameter lists\n" + "\\newenvironment{DoxyTemplParams}[1]{%\n" + " \\begin{DoxyDesc}{#1}%\n" + " \\begin{description}%\n" + "}{%\n" + " \\end{description}%\n" + " \\end{DoxyDesc}%\n" + "}\n\n"; t << "\\newcommand{\\doxyref}[3]{\\textbf{#1} (\\textnormal{#2}\\,\\pageref{#3})}\n"; - t << "\\newenvironment{DocInclude}\n"; - t << "{\\footnotesize}\n"; - t << "{\\normalsize}\n"; - t << "\\newenvironment{VerbInclude}\n"; - t << "{\\footnotesize}\n"; - t << "{\\normalsize}\n"; - t << "\\newenvironment{Image}\n"; - t << "{\\begin{figure}[H]}\n"; - t << "{\\end{figure}}\n"; - t << "\\newenvironment{ImageNoCaption}{}{}\n"; - t << "\\newenvironment{CompactList}\n"; + t << "\\newenvironment{DoxyCompactList}\n"; t << "{\\begin{list}{}{\n"; t << " \\setlength{\\leftmargin}{0.5cm}\n"; t << " \\setlength{\\itemsep}{0pt}\n"; @@ -351,7 +563,7 @@ static void writeDefaultStyleSheetPart3(QTextStream &t) t << " \\setlength{\\topsep}{0pt}\n"; t << " \\renewcommand{\\makelabel}{\\hfill}}}\n"; t << "{\\end{list}}\n"; - t << "\\newenvironment{CompactItemize}\n"; + t << "\\newenvironment{DoxyCompactItemize}\n"; t << "{\n"; t << " \\begin{itemize}\n"; t << " \\setlength{\\itemsep}{-3pt}\n"; @@ -1515,7 +1727,7 @@ void LatexGenerator::startMemberDescription() { if (!insideTabbing) { - t << "\\begin{CompactList}\\small\\item\\em "; + t << "\\begin{DoxyCompactList}\\small\\item\\em "; } else { @@ -1528,7 +1740,7 @@ void LatexGenerator::endMemberDescription() { if (!insideTabbing) { - t << "\\item\\end{CompactList}"; + t << "\\item\\end{DoxyCompactList}"; } else { @@ -1552,7 +1764,7 @@ void LatexGenerator::startMemberList() { if (!insideTabbing) { - t << "\\begin{CompactItemize}" << endl; + t << "\\begin{DoxyCompactItemize}" << endl; } } @@ -1561,7 +1773,7 @@ void LatexGenerator::endMemberList() //printf("LatexGenerator::endMemberList(%d)\n",insideTabbing); if (!insideTabbing) { - t << "\\end{CompactItemize}" << endl; + t << "\\end{DoxyCompactItemize}" << endl; } } @@ -1808,7 +2020,7 @@ void LatexGenerator::startCodeFragment() } else { - t << endl << endl << "\\begin{Code}\\begin{verbatim}"; + t << "\n\\begin{DoxyCode}\n"; } } @@ -1820,7 +2032,7 @@ void LatexGenerator::endCodeFragment() } else { - t << "\\end{verbatim}\n\\end{Code}" << endl; + t << "\\end{DoxyCode}\n"; } } diff --git a/src/latexgen.h b/src/latexgen.h index 2967c74..9b7bf74 100644 --- a/src/latexgen.h +++ b/src/latexgen.h @@ -67,14 +67,14 @@ class LatexGenerator : public OutputGenerator void writeString(const char *text); void startIndexListItem() {} void endIndexListItem() {} - void startIndexList() { t << "\\begin{CompactList}" << endl; } - void endIndexList() { t << "\\end{CompactList}" << endl; } + void startIndexList() { t << "\\begin{DoxyCompactList}" << endl; } + void endIndexList() { t << "\\end{DoxyCompactList}" << endl; } void startIndexKey(); void endIndexKey(); void startIndexValue(bool); void endIndexValue(const char *,bool); - void startItemList() { t << "\\begin{CompactItemize}" << endl; } - void endItemList() { t << "\\end{CompactItemize}" << endl; } + void startItemList() { t << "\\begin{DoxyCompactItemize}" << endl; } + void endItemList() { t << "\\end{DoxyCompactItemize}" << endl; } void startIndexItem(const char *ref,const char *file); void endIndexItem(const char *ref,const char *file); void docify(const char *text); @@ -88,7 +88,7 @@ class LatexGenerator : public OutputGenerator void endTextLink(); void startHtmlLink(const char *url); void endHtmlLink(); - void startTypewriter() { t << "{\\tt "; } + void startTypewriter() { t << "{\\ttfamily "; } void endTypewriter() { t << "}"; } void startGroupHeader(); void endGroupHeader(); @@ -130,7 +130,7 @@ class LatexGenerator : public OutputGenerator void endCodeLine(); void startEmphasis() { t << "{\\em "; } void endEmphasis() { t << "}"; } - void startBold() { t << "\\textbf{"; } + void startBold() { t << "{\\bfseries "; } void endBold() { t << "}"; } void startDescription(); void endDescription(); diff --git a/src/libdoxygen.pro.in b/src/libdoxygen.pro.in index 12711d1..7fa7816 100644 --- a/src/libdoxygen.pro.in +++ b/src/libdoxygen.pro.in @@ -48,6 +48,7 @@ HEADERS = bufstr.h \ filename.h \ formula.h \ ftvhelp.h \ + gifenc.h \ groupdef.h \ htags.h \ htmlattrib.h \ @@ -81,7 +82,6 @@ HEADERS = bufstr.h \ outputlist.h \ pagedef.h \ perlmodgen.h \ - pngenc.h \ pre.h \ printdocvisitor.h \ pycode.h \ @@ -98,7 +98,6 @@ HEADERS = bufstr.h \ rtfstyle.h \ scanner.h \ searchindex.h \ - search_php.h \ search_js.h \ search_css.h \ section.h \ @@ -180,6 +179,7 @@ SOURCES = ce_lex.cpp \ ftvhelp.cpp \ fortrancode.cpp \ fortranscanner.cpp \ + gifenc.cpp \ groupdef.cpp \ htags.cpp \ htmldocvisitor.cpp \ @@ -209,7 +209,6 @@ SOURCES = ce_lex.cpp \ outputlist.cpp \ pagedef.cpp \ perlmodgen.cpp \ - pngenc.cpp \ pre.cpp \ pycode.cpp \ pyscanner.cpp \ @@ -239,10 +238,11 @@ win32-msvc:TMAKE_CXXFLAGS += -Zm200 win32-g++:TMAKE_CXXFLAGS += -fno-exceptions -fno-rtti linux-g++:TMAKE_CXXFLAGS += -fno-exceptions -fno-rtti INCLUDEPATH += ../qtools -INCLUDEPATH += ../libpng +#INCLUDEPATH += ../libpng INCLUDEPATH += ../libmd5 win32:INCLUDEPATH += . -win32-g++:INCLUDEPATH = ../qtools /usr/include/libpng12 ../libmd5 +#win32-g++:INCLUDEPATH = ../qtools /usr/include/libpng12 ../libmd5 +win32-g++:INCLUDEPATH = ../qtools ../libmd5 DESTDIR = ../lib TARGET = doxygen OBJECTS_DIR = ../objects diff --git a/src/libdoxygen.t b/src/libdoxygen.t index f9d4d5a..ef0867e 100644 --- a/src/libdoxygen.t +++ b/src/libdoxygen.t @@ -114,9 +114,6 @@ search_js.h: search.js search_css.h: search.css cat search.css | $(TO_C_CMD) >search_css.h -search_php.h: search.php - cat search.php | $(TO_C_CMD) >search_php.h - doxygen_css.h: doxygen.css cat doxygen.css | $(TO_C_CMD) >doxygen_css.h diff --git a/src/memberdef.cpp b/src/memberdef.cpp index 630b6ff..f9637e2 100644 --- a/src/memberdef.cpp +++ b/src/memberdef.cpp @@ -1568,10 +1568,11 @@ bool MemberDef::isDetailedSectionLinkable() const (m_impl->mtype==EnumValue && !briefDescription().isEmpty()) || // has brief description that is part of the detailed description (!briefDescription().isEmpty() && // has brief docs - (alwaysDetailedSec && // they or visible in - repeatBrief || // detailed section or - !briefMemberDesc // they are explicitly not - ) // shown in brief section + (alwaysDetailedSec && // they are visible in + (repeatBrief || // detailed section or + !briefMemberDesc // they are explicitly not + ) // shown in brief section + ) ) || // has a multi-line initialization block //(initLines>0 && initLines<maxInitLines) || @@ -3045,6 +3046,13 @@ bool MemberDef::isObjCMethod() const return FALSE; } +bool MemberDef::isObjCProperty() const +{ + makeResident(); + if (m_impl->classDef && m_impl->classDef->isObjectiveC() && isProperty()) return TRUE; + return FALSE; +} + QCString MemberDef::qualifiedName() const { makeResident(); diff --git a/src/memberdef.h b/src/memberdef.h index a171220..898efa1 100644 --- a/src/memberdef.h +++ b/src/memberdef.h @@ -164,6 +164,7 @@ class MemberDef : public Definition bool hasDocumentedParams() const; bool hasDocumentedReturnType() const; bool isObjCMethod() const; + bool isObjCProperty() const; bool isConstructor() const; bool isDestructor() const; bool hasOneLineInitializer() const; diff --git a/src/memberlist.cpp b/src/memberlist.cpp index 8091362..a5d9fd8 100644 --- a/src/memberlist.cpp +++ b/src/memberlist.cpp @@ -48,8 +48,17 @@ MemberList::~MemberList() int MemberList::compareItems(GCI item1, GCI item2) { + static bool sortConstructorsFirst = Config_getBool("SORT_MEMBERS_CTORS_1ST"); MemberDef *c1=(MemberDef *)item1; MemberDef *c2=(MemberDef *)item2; + if (sortConstructorsFirst) { + int ord1 = c1->isConstructor() ? 2 : (c1->isDestructor() ? 1 : 0); + int ord2 = c2->isConstructor() ? 2 : (c2->isDestructor() ? 1 : 0); + if (ord1 > ord2) + return -1; + else if (ord2 > ord1) + return 1; + } return stricmp(c1->name(),c2->name()); } diff --git a/src/message.cpp b/src/message.cpp index 9466beb..9493cec 100644 --- a/src/message.cpp +++ b/src/message.cpp @@ -150,7 +150,7 @@ static void do_warn(const char *tag, const char *file, int line, const char *fmt )+'\n'; // print resulting message - fprintf(warnFile,msgText); + fprintf(warnFile,"%s",msgText.data()); } void warn(const char *file,int line,const char *fmt, ...) diff --git a/src/msc.cpp b/src/msc.cpp index f17ab0b..233a838 100644 --- a/src/msc.cpp +++ b/src/msc.cpp @@ -32,7 +32,9 @@ static bool convertMapFile(QTextStream &t,const char *mapName,const QCString rel QFile f(mapName); if (!f.open(IO_ReadOnly)) { - err("Error opening map file %s for inclusion in the docs!\n",mapName); + err("Error opening map file %s for inclusion in the docs!\n" + "If you installed Graphviz/dot after a previous failing run, \n" + "try deleting the output directory and rerun doxygen.\n",mapName); return FALSE; } const int maxLineLen=1024; diff --git a/src/pngenc.cpp b/src/pngenc.cpp deleted file mode 100644 index 6f8206e..0000000 --- a/src/pngenc.cpp +++ /dev/null @@ -1,170 +0,0 @@ -/****************************************************************************** - * - * - * - * - * Copyright (C) 1997-2008 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. - * - * --------------------------------------------------------------------------- - * - * The Portable Network Graphic format is an ISO Standard. - * Most of the code below was donated by Bernhard Ristow. - */ - -#ifndef png_jmpbuf -# define png_jmpbuf(png_ptr) ((png_ptr)->jmpbuf) -#endif - -#define ALL_STATIC -#include <../libpng/png.h> -#include <stdio.h> -#include <stdlib.h> -#include <string.h> -#include <errno.h> -#include "pngenc.h" -#include "message.h" - -#undef jmpbuf - -static void user_error_fn(png_structp, png_const_charp error_msg) -{ - err("%s\n", error_msg); -} - -static void user_warning_fn(png_structp, png_const_charp warning_msg) -{ - err("%s\n", warning_msg); -} - -PngEncoder::PngEncoder(Byte *rawBytes, Color *p, int w, int h, Byte d, int t) : - data(rawBytes), palette(p), width(w), height(h), depth(d), transIndex(t) -{ - numPixels = w*h; - dataPtr = data; -} - -PngEncoder::~PngEncoder() -{ -} - -void PngEncoder::write(const char *name) -{ - FILE * file = NULL; - unsigned char ** rows = 0; - unsigned char * cmap = 0; - short numOfColors = (1<<depth); - short bit_depth = 4; - long i = 0; - long j = 0; - png_structp png_ptr; - png_infop info_ptr; - char user_error_ptr[] = "PngEncoder"; - png_colorp png_palette; - png_byte ti[1]; - - png_ptr = png_create_write_struct - ( PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr, - user_error_fn, user_warning_fn); - if (!png_ptr) - { - err("Can not allocate writing structure!\n"); - return; - } - - info_ptr = png_create_info_struct(png_ptr); - if (!info_ptr) - { - png_destroy_write_struct(&png_ptr, (png_infopp)NULL); - err("Can not allocate writing structure!\n"); - return; - } - - if (setjmp(png_jmpbuf(png_ptr))) - { - png_destroy_write_struct(&png_ptr, &info_ptr); - return; - } - else - { - png_palette = (png_colorp) png_malloc(png_ptr, - PNG_MAX_PALETTE_LENGTH*sizeof(png_color)); - memset(png_palette,0,PNG_MAX_PALETTE_LENGTH*sizeof(png_color)); - for (i=0; i<numOfColors; i++) - { - png_palette[i].red = palette[i].red; - png_palette[i].green = palette[i].green; - png_palette[i].blue = palette[i].blue; - } - png_set_PLTE(png_ptr, info_ptr, png_palette, numOfColors); - png_set_IHDR( png_ptr, info_ptr, width, height, bit_depth, - PNG_COLOR_TYPE_PALETTE, PNG_INTERLACE_NONE, - PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE - ); - free(png_palette); - ti[0] = transIndex; - png_set_tRNS(png_ptr,info_ptr,ti,1,NULL); - rows = (unsigned char **) calloc(sizeof(unsigned char*),height); - rows[0] = (unsigned char *) calloc(sizeof(unsigned char),height*width); - for (i=1; i<height; i++) - { - rows[i] = rows[i-1] + width; - } - for (i=0, dataPtr=data; i<height; i++) - { - for (j=0; j<width; j++) - { - if (j%2) - { - rows[i][j/2] = ( rows[i][j/2] | *dataPtr ); - } - else - { - rows[i][j/2] = (*dataPtr) << 4; - } - dataPtr++; - } - } - png_set_rows(png_ptr,info_ptr,rows); - - file = fopen(name,"wb"); - if (file==0) - { - err("Error opening png file %s for writing: %s!\n",name,strerror(errno)); - } - else - { - png_init_io(png_ptr,file); - png_write_png(png_ptr,info_ptr,PNG_TRANSFORM_IDENTITY,NULL); - } - } - - png_destroy_write_struct(&png_ptr, &info_ptr); - - if (file) - { - fclose (file); - } - if (cmap) - { - free(cmap); - } - if (rows) - { - if (rows[0]) - { - free(rows[0]); - } - free(rows); - } - return; -} - diff --git a/src/pngenc.h b/src/pngenc.h deleted file mode 100644 index bb2abe4..0000000 --- a/src/pngenc.h +++ /dev/null @@ -1,58 +0,0 @@ -/****************************************************************************** - * - * - * - * - * Copyright (C) 1997-2008 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. - * - */ - -#ifndef _PNGENC_H -#define _PNGENC_H -#include <qfile.h> - -typedef unsigned char Byte; - -/*! \brief Entry in the color palette of a PNG image */ -struct Color -{ - Byte red; - Byte green; - Byte blue; -}; - -/*! \brief PNG image encoder - * - * This class allows to encode a raw image to a compressed PNG. - * Use write() to save the result to disk. - */ -class PngEncoder -{ - public: - PngEncoder(Byte *rawBytes,Color *p,int w,int h,Byte d,int t); - ~PngEncoder(); - void write(const char *fileName); - - private: - // image variables - Byte *data; // pointer to the image data (one byte per pixel) - Color *palette; // pointer to the color palette - int width; // image width - int height; // image height - Byte depth; // bits per CLUT entry - int transIndex; // index of the transparant color; -1 = none - int numPixels; // total number of pixel (i.e. width * height) - Byte *dataPtr; // pointer located at the current pixel. - -}; - -#endif @@ -86,7 +86,7 @@ static QArray<int> g_levelGuard; static BufStr *g_outputBuf; static int g_roundCount; static bool g_quoteArg; -static DefineDict *g_fileDefineDict; +static DefineDict *g_fileDefineDict = new DefineDict(10009); static DefineDict *g_expandedDict; static int g_findDefArgContext; static QCString g_lastGuardName; @@ -108,7 +108,8 @@ static bool g_insideCS; // C# has simpler preprocessor static bool g_lexInit = FALSE; -DefineDict* getFileDefineDict() { +DefineDict* getFileDefineDict() +{ return g_fileDefineDict; } @@ -176,6 +177,8 @@ static Define *isDefined(const char *name) return 0; } +static QDict<void> g_allIncludes(10009); + static FileState *checkAndOpenFile(const QCString &fileName) { FileState *fs = 0; @@ -184,8 +187,15 @@ static FileState *checkAndOpenFile(const QCString &fileName) if (fi.exists() && fi.isFile()) { QCString absName = convertToQCString(fi.absFilePath()); + +#if 1 + // global guard + if (g_allIncludes.find(absName)) return 0; // already done + g_allIncludes.insert(absName,(void *)0x8); // check include stack for absName +#endif +#if 0 // stack based recusive inclusion detection QStack<FileState> tmpStack; g_includeStack.setAutoDelete(FALSE); bool alreadyIncluded=FALSE; @@ -201,6 +211,8 @@ static FileState *checkAndOpenFile(const QCString &fileName) g_includeStack.setAutoDelete(TRUE); if (alreadyIncluded) return 0; +#endif + //printf("#include %s\n",absName.data()); fs = new FileState; @@ -688,11 +700,14 @@ static int getNextId(const QCString &expr,int p,int *l) while (p<(int)expr.length()) { char c=expr.at(p++); - if (isalpha(c) || c=='_') // read id + if (isdigit(c)) // skip number + { + while (p<(int)expr.length() && isId(expr.at(p))) p++; + } + else if (isalpha(c) || c=='_') // read id { n=p-1; - while (p<(int)expr.length() && isId(expr.at(p)) - ) p++; + while (p<(int)expr.length() && isId(expr.at(p))) p++; *l=p-n; return n; } @@ -747,7 +762,6 @@ static void expandExpression(QCString &expr,QCString *rest,int pos) { bool replaced=FALSE; macroName=expr.mid(p,l); - //printf("macroName %s found\n",macroName.data()); if (p<2 || !(expr.at(p-2)=='@' && expr.at(p-1)=='-')) // no-rescan marker? { if (g_expandedDict->find(macroName)==0) // expand macro @@ -1337,6 +1351,7 @@ CHARLIT (("'"\\[0-7]{1,3}"'")|("'"\\."'")|("'"[^'\\\n]{1,4}"'")) } BEGIN(CopyLine); } +<Start>^{B}*[_A-Z][_A-Z0-9]*{B}*"("[^\(\)\n]*"("[^\)\n]*")"[^\)\n]*")"{B}*\n | // function list macro with one (...) argument, e.g. for K_GLOBAL_STATIC_WITH_ARGS <Start>^{B}*[_A-Z][_A-Z0-9]*{B}*"("[^\)\n]*")"{B}*\n { // function like macro static bool skipFuncMacros = Config_getBool("SKIP_FUNCTION_MACROS"); QCString name(yytext); @@ -1746,11 +1761,11 @@ CHARLIT (("'"\\[0-7]{1,3}"'")|("'"\\."'")|("'"[^'\\\n]{1,4}"'")) <SkipCommand>. <SkipLine>[^/\n]+ <SkipLine>. -<SkipLine,SkipCommand,SkipCPPBlock>"//" { +<SkipLine,SkipCommand,SkipCPPBlock>"//"[^\n]* { g_lastCPPContext=YY_START; BEGIN(RemoveCPPComment); } -<SkipLine,SkipCommand,SkipCPPBlock>"/*" { +<SkipLine,SkipCommand,SkipCPPBlock>"/*"/[^\n]* { g_lastCContext=YY_START; BEGIN(RemoveCComment); } @@ -1839,11 +1854,8 @@ CHARLIT (("'"\\[0-7]{1,3}"'")|("'"\\."'")|("'"[^'\\\n]{1,4}"'")) else // define is a guard => hide { //printf("Found a guard %s\n",yytext); +#if 0 Define *def=g_fileDefineDict->find(g_defName); - //if (g_includeStack.isEmpty()) - //{ - // addDefine(); - //} if (def==0) // new define name for this file { g_fileDefineDict->insert(g_defName,newDefine()); @@ -1864,6 +1876,7 @@ CHARLIT (("'"\\[0-7]{1,3}"'")|("'"\\."'")|("'"[^'\\\n]{1,4}"'")) //printf("Error: define %s is defined more than once!\n",g_defName.data()); } } +#endif g_lastGuardName.resize(0); BEGIN(Start); } @@ -2329,13 +2342,13 @@ void initPreprocessor() //defineDict.clear(); //fileDefineCache = new DefineCache(1009); g_expandedDict = new DefineDict(17); - g_fileDefineDict = new DefineDict(1009); + //g_fileDefineDict = new DefineDict(1009); } void cleanUpPreprocessor() { //delete fileDefineCache; - delete g_fileDefineDict; g_fileDefineDict=0; + //delete g_fileDefineDict; g_fileDefineDict=0; delete g_expandedDict; g_expandedDict=0; delete g_pathList; g_pathList=0; } @@ -2352,115 +2365,119 @@ void preprocessFile(const char *fileName,BufStr &output) g_outputBuf=&output; g_includeStack.setAutoDelete(TRUE); g_includeStack.clear(); - g_fileDefineDict->setAutoDelete(TRUE); - g_fileDefineDict->clear(); + //g_fileDefineDict->setAutoDelete(TRUE); + //g_fileDefineDict->clear(); g_expandedDict->setAutoDelete(FALSE); g_expandedDict->clear(); g_condStack.clear(); g_condStack.setAutoDelete(TRUE); - // add predefined macros - char *defStr; - QStrList &predefList = Config_getList("PREDEFINED"); - QStrListIterator sli(predefList); - for (sli.toFirst();(defStr=sli.current());++sli) + static bool firstTime=TRUE; + if (firstTime) { - QCString ds = defStr; - int i_equals=ds.find('='); - int i_obrace=ds.find('('); - int i_cbrace=ds.find(')'); - bool nonRecursive = i_equals>0 && ds.at(i_equals-1)==':'; - - if (i_obrace==0) continue; // no define name - - if (i_obrace<i_equals && i_cbrace<i_equals && - i_obrace!=-1 && i_cbrace!=-1 && - i_obrace<i_cbrace - ) // predefined function macro definition + // add predefined macros + char *defStr; + QStrList &predefList = Config_getList("PREDEFINED"); + QStrListIterator sli(predefList); + for (sli.toFirst();(defStr=sli.current());++sli) { - QRegExp reId("[a-z_A-Z][a-z_A-Z0-9]*"); // regexp matching an id - QDict<int> argDict(17); - argDict.setAutoDelete(TRUE); - int i=i_obrace+1,p,l,count=0; - // gather the formal arguments in a dictionary - while (i<i_cbrace && (p=reId.match(ds,i,&l))) - { - argDict.insert(ds.mid(p,l),new int(count++)); - i=p+l; - } - // strip definition part - QCString tmp=ds.right(ds.length()-i_equals-1); - QCString definition; - i=0; - // substitute all occurrences of formal arguments by their - // corresponding markers - while ((p=reId.match(tmp,i,&l))!=-1) + QCString ds = defStr; + int i_equals=ds.find('='); + int i_obrace=ds.find('('); + int i_cbrace=ds.find(')'); + bool nonRecursive = i_equals>0 && ds.at(i_equals-1)==':'; + + if (i_obrace==0) continue; // no define name + + if (i_obrace<i_equals && i_cbrace<i_equals && + i_obrace!=-1 && i_cbrace!=-1 && + i_obrace<i_cbrace + ) // predefined function macro definition { - if (p>i) definition+=tmp.mid(i,p-i); - int *argIndex; - if ((argIndex=argDict[tmp.mid(p,l)])!=0) + QRegExp reId("[a-z_A-Z][a-z_A-Z0-9]*"); // regexp matching an id + QDict<int> argDict(17); + argDict.setAutoDelete(TRUE); + int i=i_obrace+1,p,l,count=0; + // gather the formal arguments in a dictionary + while (i<i_cbrace && (p=reId.match(ds,i,&l))) { - QCString marker; - marker.sprintf(" @%d ",*argIndex); - definition+=marker; + argDict.insert(ds.mid(p,l),new int(count++)); + i=p+l; } - else + // strip definition part + QCString tmp=ds.right(ds.length()-i_equals-1); + QCString definition; + i=0; + // substitute all occurrences of formal arguments by their + // corresponding markers + while ((p=reId.match(tmp,i,&l))!=-1) + { + if (p>i) definition+=tmp.mid(i,p-i); + int *argIndex; + if ((argIndex=argDict[tmp.mid(p,l)])!=0) + { + QCString marker; + marker.sprintf(" @%d ",*argIndex); + definition+=marker; + } + else + { + definition+=tmp.mid(p,l); + } + i=p+l; + } + if (i<(int)tmp.length()) definition+=tmp.mid(i,tmp.length()-i); + + // add define definition to the dictionary of defines for this file + QCString dname = ds.left(i_obrace); + if (!dname.isEmpty()) { - definition+=tmp.mid(p,l); + Define *def = new Define; + def->name = dname; + def->definition = definition; + def->nargs = count; + def->isPredefined = TRUE; + def->nonRecursive = nonRecursive; + g_fileDefineDict->insert(def->name,def); } - i=p+l; + + //printf("#define `%s' `%s' #nargs=%d\n", + // def->name.data(),def->definition.data(),def->nargs); } - if (i<(int)tmp.length()) definition+=tmp.mid(i,tmp.length()-i); - - // add define definition to the dictionary of defines for this file - QCString dname = ds.left(i_obrace); - if (!dname.isEmpty()) + else if ((i_obrace==-1 || i_obrace>i_equals) && + (i_cbrace==-1 || i_cbrace>i_equals) && + !ds.isEmpty() && (int)ds.length()>i_equals + ) // predefined non-function macro definition { Define *def = new Define; - def->name = dname; - def->definition = definition; - def->nargs = count; - def->isPredefined = TRUE; - def->nonRecursive = nonRecursive; - g_fileDefineDict->insert(def->name,def); - } + if (i_equals==-1) // simple define without argument + { + def->name = ds; + def->definition = "1"; // substitute occurrences by 1 (true) + } + else // simple define with argument + { + int ine=i_equals - (nonRecursive ? 1 : 0); + def->name = ds.left(ine); + def->definition = ds.right(ds.length()-i_equals-1); + } + if (!def->name.isEmpty()) + { + def->nargs = -1; + def->isPredefined = TRUE; + def->nonRecursive = nonRecursive; + g_fileDefineDict->insert(def->name,def); + } + else + { + delete def; + } - //printf("#define `%s' `%s' #nargs=%d\n", - // def->name.data(),def->definition.data(),def->nargs); - } - else if ((i_obrace==-1 || i_obrace>i_equals) && - (i_cbrace==-1 || i_cbrace>i_equals) && - !ds.isEmpty() && (int)ds.length()>i_equals - ) // predefined non-function macro definition - { - Define *def = new Define; - if (i_equals==-1) // simple define without argument - { - def->name = ds; - def->definition = "1"; // substitute occurrences by 1 (true) + //printf("#define `%s' `%s' #nargs=%d\n", + // def->name.data(),def->definition.data(),def->nargs); } - else // simple define with argument - { - int ine=i_equals - (nonRecursive ? 1 : 0); - def->name = ds.left(ine); - def->definition = ds.right(ds.length()-i_equals-1); - } - if (!def->name.isEmpty()) - { - def->nargs = -1; - def->isPredefined = TRUE; - def->nonRecursive = nonRecursive; - g_fileDefineDict->insert(def->name,def); - } - else - { - delete def; - } - - //printf("#define `%s' `%s' #nargs=%d\n", - // def->name.data(),def->definition.data(),def->nargs); } - + firstTime=FALSE; } QCString inputFilter = getFileFilter(fileName); diff --git a/src/pycode.l b/src/pycode.l index aa72b43..0acc23e 100644 --- a/src/pycode.l +++ b/src/pycode.l @@ -395,7 +395,7 @@ static void startCodeLine() } } -static void codify(char* text) +static void codify(const char* text) { g_code->codify(text); } @@ -421,7 +421,7 @@ static void writeMultiLineCodeLink(CodeOutputInterface &ol, { char *sp=p; char c; - while ((c=*p++) && c!='\n'); + while ((c=*p++) && c!='\n') { } if (c=='\n') { g_yyLineNr++; @@ -453,7 +453,7 @@ static void codifyLines(char *text) while (!done) { sp=p; - while ((c=*p++) && c!='\n'); + while ((c=*p++) && c!='\n') { } if (c=='\n') { g_yyLineNr++; diff --git a/src/scanner.l b/src/scanner.l index c6db28c..f112d5b 100644 --- a/src/scanner.l +++ b/src/scanner.l @@ -866,13 +866,20 @@ TYPEDEFPREFIX (("typedef"{BN}+)?)((("volatile"|"const"){BN}+)?) lineCount() ; } <FindMembers>{B}*"internal"{BN}*":"{BN}* { // for now treat C++/CLI's internal as package... - current->protection = protection = Package ; - current->mtype = mtype = Method; - current->type.resize(0); - current->name.resize(0); - current->args.resize(0); - current->argList->clear(); - lineCount() ; + if (insideCli) + { + current->protection = protection = Package ; + current->mtype = mtype = Method; + current->type.resize(0); + current->name.resize(0); + current->args.resize(0); + current->argList->clear(); + lineCount() ; + } + else + { + REJECT; + } } <FindMembers>{B}*"protected"{BN}*":"{BN}* { current->protection = protection = Protected ; @@ -2706,8 +2713,9 @@ TYPEDEFPREFIX (("typedef"{BN}+)?)((("volatile"|"const"){BN}+)?) <FindMembers>"[" { if (!insideCS && - current->name.isEmpty() || - current->name=="typedef" + (current->name.isEmpty() || + current->name=="typedef" + ) ) // IDL function property { squareCount=1; diff --git a/src/search.js b/src/search.js index 7f81e57..49655c5 100644 --- a/src/search.js +++ b/src/search.js @@ -56,7 +56,7 @@ function getYPos(item) storing this instance. Is needed to be able to set timeouts. resultPath - path to use for external files */ -function SearchBox(name, resultsPath, inFrame) +function SearchBox(name, resultsPath, inFrame, label) { if (!name || !resultsPath) { alert("Missing parameters to SearchBox."); } @@ -72,6 +72,7 @@ function SearchBox(name, resultsPath, inFrame) this.searchIndex = 0; this.searchActive = false; this.insideFrame = inFrame; + this.searchLabel = label; // ----------- DOM Elements @@ -382,7 +383,7 @@ function SearchBox(name, resultsPath, inFrame) var searchField = this.DOMSearchField(); - if (searchField.value == 'Search') // clear "Search" term upon entry + if (searchField.value == this.searchLabel) // clear "Search" term upon entry { searchField.value = ''; this.searchActive = true; @@ -391,7 +392,7 @@ function SearchBox(name, resultsPath, inFrame) else if (!isActive) // directly remove the panel { this.DOMSearchBox().className = 'MSearchBoxInactive'; - this.DOMSearchField().value = 'Search'; + this.DOMSearchField().value = this.searchLabel; this.searchActive = false; this.lastSearchValue = '' this.lastResultsPage = ''; diff --git a/src/search.php b/src/search.php deleted file mode 100644 index f86184c..0000000 --- a/src/search.php +++ /dev/null @@ -1,324 +0,0 @@ -function readInt($file) -{ - $b1 = ord(fgetc($file)); $b2 = ord(fgetc($file)); - $b3 = ord(fgetc($file)); $b4 = ord(fgetc($file)); - return ($b1<<24)|($b2<<16)|($b3<<8)|$b4; -} - -function readString($file) -{ - $result=""; - while (ord($c=fgetc($file))) $result.=$c; - return $result; -} - -function readHeader($file) -{ - $header =fgetc($file); $header.=fgetc($file); - $header.=fgetc($file); $header.=fgetc($file); - return $header; -} - -function computeIndex($word) -{ - // Fast string hashing - //$lword = strtolower($word); - //$l = strlen($lword); - //for ($i=0;$i<$l;$i++) - //{ - // $c = ord($lword{$i}); - // $v = (($v & 0xfc00) ^ ($v << 6) ^ $c) & 0xffff; - //} - //return $v; - - // Simple hashing that allows for substring search - if (strlen($word)<2) return -1; - // high char of the index - $hi = ord($word{0}); - if ($hi==0) return -1; - // low char of the index - $lo = ord($word{1}); - if ($lo==0) return -1; - // return index - return $hi*256+$lo; -} - -function search($file,$word,&$statsList) -{ - $index = computeIndex($word); - if ($index!=-1) // found a valid index - { - fseek($file,$index*4+4); // 4 bytes per entry, skip header - $index = readInt($file); - if ($index) // found words matching the hash key - { - $start=sizeof($statsList); - $count=$start; - fseek($file,$index); - $w = readString($file); - while ($w) - { - $statIdx = readInt($file); - if ($word==substr($w,0,strlen($word))) - { // found word that matches (as substring) - $statsList[$count++]=array( - "word"=>$word, - "match"=>$w, - "index"=>$statIdx, - "full"=>strlen($w)==strlen($word), - "docs"=>array() - ); - } - $w = readString($file); - } - $totalHi=0; - $totalFreqHi=0; - $totalFreqLo=0; - for ($count=$start;$count<sizeof($statsList);$count++) - { - $statInfo = &$statsList[$count]; - $multiplier = 1; - // whole word matches have a double weight - if ($statInfo["full"]) $multiplier=2; - fseek($file,$statInfo["index"]); - $numDocs = readInt($file); - $docInfo = array(); - // read docs info + occurrence frequency of the word - for ($i=0;$i<$numDocs;$i++) - { - $idx=readInt($file); - $freq=readInt($file); - $docInfo[$i]=array("idx" => $idx, - "freq" => $freq>>1, - "rank" => 0.0, - "hi" => $freq&1 - ); - if ($freq&1) // word occurs in high priority doc - { - $totalHi++; - $totalFreqHi+=$freq*$multiplier; - } - else // word occurs in low priority doc - { - $totalFreqLo+=$freq*$multiplier; - } - } - // read name and url info for the doc - for ($i=0;$i<$numDocs;$i++) - { - fseek($file,$docInfo[$i]["idx"]); - $docInfo[$i]["name"]=readString($file); - $docInfo[$i]["url"]=readString($file); - } - $statInfo["docs"]=$docInfo; - } - $totalFreq=($totalHi+1)*$totalFreqLo + $totalFreqHi; - for ($count=$start;$count<sizeof($statsList);$count++) - { - $statInfo = &$statsList[$count]; - $multiplier = 1; - // whole word matches have a double weight - if ($statInfo["full"]) $multiplier=2; - for ($i=0;$i<sizeof($statInfo["docs"]);$i++) - { - $docInfo = &$statInfo["docs"]; - // compute frequency rank of the word in each doc - $freq=$docInfo[$i]["freq"]; - if ($docInfo[$i]["hi"]) - { - $statInfo["docs"][$i]["rank"]= - (float)($freq*$multiplier+$totalFreqLo)/$totalFreq; - } - else - { - $statInfo["docs"][$i]["rank"]= - (float)($freq*$multiplier)/$totalFreq; - } - } - } - } - } - return $statsList; -} - -function combine_results($results,&$docs) -{ - foreach ($results as $wordInfo) - { - $docsList = &$wordInfo["docs"]; - foreach ($docsList as $di) - { - $key=$di["url"]; - $rank=$di["rank"]; - if (in_array($key, array_keys($docs))) - { - $docs[$key]["rank"]+=$rank; - } - else - { - $docs[$key] = array("url"=>$key, - "name"=>$di["name"], - "rank"=>$rank - ); - } - $docs[$key]["words"][] = array( - "word"=>$wordInfo["word"], - "match"=>$wordInfo["match"], - "freq"=>$di["freq"] - ); - } - } - return $docs; -} - -function filter_results($docs,&$requiredWords,&$forbiddenWords) -{ - $filteredDocs=array(); - while (list ($key, $val) = each ($docs)) - { - $words = &$docs[$key]["words"]; - $copy=1; // copy entry by default - if (sizeof($requiredWords)>0) - { - foreach ($requiredWords as $reqWord) - { - $found=0; - foreach ($words as $wordInfo) - { - $found = $wordInfo["word"]==$reqWord; - if ($found) break; - } - if (!$found) - { - $copy=0; // document contains none of the required words - break; - } - } - } - if (sizeof($forbiddenWords)>0) - { - foreach ($words as $wordInfo) - { - if (in_array($wordInfo["word"],$forbiddenWords)) - { - $copy=0; // document contains a forbidden word - break; - } - } - } - if ($copy) $filteredDocs[$key]=$docs[$key]; - } - return $filteredDocs; -} - -function compare_rank($a,$b) -{ - if ($a["rank"] == $b["rank"]) - { - return 0; - } - return ($a["rank"]>$b["rank"]) ? -1 : 1; -} - -function sort_results($docs,&$sorted) -{ - $sorted = $docs; - usort($sorted,"compare_rank"); - return $sorted; -} - -function report_results(&$docs) -{ - echo "<table cellspacing=\"2\">\n"; - echo " <tr>\n"; - echo " <td colspan=\"2\"><h2>".search_results()."</h2></td>\n"; - echo " </tr>\n"; - $numDocs = sizeof($docs); - if ($numDocs==0) - { - echo " <tr>\n"; - echo " <td colspan=\"2\">".matches_text(0)."</td>\n"; - echo " </tr>\n"; - } - else - { - echo " <tr>\n"; - echo " <td colspan=\"2\">".matches_text($numDocs); - echo "\n"; - echo " </td>\n"; - echo " </tr>\n"; - $num=1; - foreach ($docs as $doc) - { - echo " <tr>\n"; - echo " <td align=\"right\">$num.</td>"; - echo "<td><a class=\"el\" href=\"".$doc["url"]."\">".$doc["name"]."</a></td>\n"; - echo " <tr>\n"; - echo " <td></td><td class=\"tiny\">".report_matches()." "; - foreach ($doc["words"] as $wordInfo) - { - $word = $wordInfo["word"]; - $matchRight = substr($wordInfo["match"],strlen($word)); - echo "<b>$word</b>$matchRight(".$wordInfo["freq"].") "; - } - echo " </td>\n"; - echo " </tr>\n"; - $num++; - } - } - echo "</table>\n"; -} - -function main() -{ - if(strcmp('4.1.0', phpversion()) > 0) - { - die("Error: PHP version 4.1.0 or above required!"); - } - if (!($file=fopen("search.idx","rb"))) - { - die("Error: Search index file could NOT be opened!"); - } - if (readHeader($file)!="DOXS") - { - die("Error: Header of index file is invalid!"); - } - $query=""; - if (array_key_exists("query", $_GET)) - { - $query=$_GET["query"]; - } - end_form(ereg_replace("[^[:alnum:]:\\.\\t ]", " ", $query )); - echo " \n<div class=\"searchresults\">\n"; - $results = array(); - $requiredWords = array(); - $forbiddenWords = array(); - $foundWords = array(); - $word=strtok($query," "); - while ($word) // for each word in the search query - { - if (($word{0}=='+')) { $word=substr($word,1); $requiredWords[]=$word; } - if (($word{0}=='-')) { $word=substr($word,1); $forbiddenWords[]=$word; } - if (!in_array($word,$foundWords)) - { - $foundWords[]=$word; - search($file,strtolower($word),$results); - } - $word=strtok(" "); - } - $docs = array(); - combine_results($results,$docs); - // filter out documents with forbidden word or that do not contain - // required words - $filteredDocs = filter_results($docs,$requiredWords,$forbiddenWords); - // sort the results based on rank - $sorted = array(); - sort_results($filteredDocs,$sorted); - // report results to the user - report_results($sorted); - echo "</div>\n"; - fclose($file); -} - -main(); - diff --git a/src/search_js.h b/src/search_js.h index d7b2a75..51fdb00 100644 --- a/src/search_js.h +++ b/src/search_js.h @@ -56,7 +56,7 @@ " storing this instance. Is needed to be able to set timeouts.\n" " resultPath - path to use for external files\n" "*/\n" -"function SearchBox(name, resultsPath, inFrame)\n" +"function SearchBox(name, resultsPath, inFrame, label)\n" "{\n" " if (!name || !resultsPath) { alert(\"Missing parameters to SearchBox.\"); }\n" " \n" @@ -72,6 +72,7 @@ " this.searchIndex = 0;\n" " this.searchActive = false;\n" " this.insideFrame = inFrame;\n" +" this.searchLabel = label;\n" "\n" " // ----------- DOM Elements\n" "\n" @@ -382,7 +383,7 @@ "\n" " var searchField = this.DOMSearchField();\n" "\n" -" if (searchField.value == 'Search') // clear \"Search\" term upon entry\n" +" if (searchField.value == this.searchLabel) // clear \"Search\" term upon entry\n" " { \n" " searchField.value = ''; \n" " this.searchActive = true;\n" @@ -391,7 +392,7 @@ " else if (!isActive) // directly remove the panel\n" " {\n" " this.DOMSearchBox().className = 'MSearchBoxInactive';\n" -" this.DOMSearchField().value = 'Search';\n" +" this.DOMSearchField().value = this.searchLabel;\n" " this.searchActive = false;\n" " this.lastSearchValue = ''\n" " this.lastResultsPage = '';\n" diff --git a/src/search_php.h b/src/search_php.h deleted file mode 100644 index afbfc74..0000000 --- a/src/search_php.h +++ /dev/null @@ -1,324 +0,0 @@ -"function readInt($file)\n" -"{\n" -" $b1 = ord(fgetc($file)); $b2 = ord(fgetc($file));\n" -" $b3 = ord(fgetc($file)); $b4 = ord(fgetc($file));\n" -" return ($b1<<24)|($b2<<16)|($b3<<8)|$b4;\n" -"}\n" -"\n" -"function readString($file)\n" -"{\n" -" $result=\"\";\n" -" while (ord($c=fgetc($file))) $result.=$c;\n" -" return $result;\n" -"}\n" -"\n" -"function readHeader($file)\n" -"{\n" -" $header =fgetc($file); $header.=fgetc($file);\n" -" $header.=fgetc($file); $header.=fgetc($file);\n" -" return $header;\n" -"}\n" -"\n" -"function computeIndex($word)\n" -"{\n" -" // Fast string hashing\n" -" //$lword = strtolower($word);\n" -" //$l = strlen($lword);\n" -" //for ($i=0;$i<$l;$i++)\n" -" //{\n" -" // $c = ord($lword{$i});\n" -" // $v = (($v & 0xfc00) ^ ($v << 6) ^ $c) & 0xffff;\n" -" //}\n" -" //return $v;\n" -"\n" -" // Simple hashing that allows for substring search\n" -" if (strlen($word)<2) return -1;\n" -" // high char of the index\n" -" $hi = ord($word{0});\n" -" if ($hi==0) return -1;\n" -" // low char of the index\n" -" $lo = ord($word{1});\n" -" if ($lo==0) return -1;\n" -" // return index\n" -" return $hi*256+$lo;\n" -"}\n" -"\n" -"function search($file,$word,&$statsList)\n" -"{\n" -" $index = computeIndex($word);\n" -" if ($index!=-1) // found a valid index\n" -" {\n" -" fseek($file,$index*4+4); // 4 bytes per entry, skip header\n" -" $index = readInt($file);\n" -" if ($index) // found words matching the hash key\n" -" {\n" -" $start=sizeof($statsList);\n" -" $count=$start;\n" -" fseek($file,$index);\n" -" $w = readString($file);\n" -" while ($w)\n" -" {\n" -" $statIdx = readInt($file);\n" -" if ($word==substr($w,0,strlen($word)))\n" -" { // found word that matches (as substring)\n" -" $statsList[$count++]=array(\n" -" \"word\"=>$word,\n" -" \"match\"=>$w,\n" -" \"index\"=>$statIdx,\n" -" \"full\"=>strlen($w)==strlen($word),\n" -" \"docs\"=>array()\n" -" );\n" -" }\n" -" $w = readString($file);\n" -" }\n" -" $totalHi=0;\n" -" $totalFreqHi=0;\n" -" $totalFreqLo=0;\n" -" for ($count=$start;$count<sizeof($statsList);$count++)\n" -" {\n" -" $statInfo = &$statsList[$count];\n" -" $multiplier = 1;\n" -" // whole word matches have a double weight\n" -" if ($statInfo[\"full\"]) $multiplier=2;\n" -" fseek($file,$statInfo[\"index\"]); \n" -" $numDocs = readInt($file);\n" -" $docInfo = array();\n" -" // read docs info + occurrence frequency of the word\n" -" for ($i=0;$i<$numDocs;$i++)\n" -" {\n" -" $idx=readInt($file); \n" -" $freq=readInt($file); \n" -" $docInfo[$i]=array(\"idx\" => $idx,\n" -" \"freq\" => $freq>>1,\n" -" \"rank\" => 0.0,\n" -" \"hi\" => $freq&1\n" -" );\n" -" if ($freq&1) // word occurs in high priority doc\n" -" {\n" -" $totalHi++;\n" -" $totalFreqHi+=$freq*$multiplier;\n" -" }\n" -" else // word occurs in low priority doc\n" -" {\n" -" $totalFreqLo+=$freq*$multiplier;\n" -" }\n" -" }\n" -" // read name and url info for the doc\n" -" for ($i=0;$i<$numDocs;$i++)\n" -" {\n" -" fseek($file,$docInfo[$i][\"idx\"]);\n" -" $docInfo[$i][\"name\"]=readString($file);\n" -" $docInfo[$i][\"url\"]=readString($file);\n" -" }\n" -" $statInfo[\"docs\"]=$docInfo;\n" -" }\n" -" $totalFreq=($totalHi+1)*$totalFreqLo + $totalFreqHi;\n" -" for ($count=$start;$count<sizeof($statsList);$count++)\n" -" {\n" -" $statInfo = &$statsList[$count];\n" -" $multiplier = 1;\n" -" // whole word matches have a double weight\n" -" if ($statInfo[\"full\"]) $multiplier=2;\n" -" for ($i=0;$i<sizeof($statInfo[\"docs\"]);$i++)\n" -" {\n" -" $docInfo = &$statInfo[\"docs\"];\n" -" // compute frequency rank of the word in each doc\n" -" $freq=$docInfo[$i][\"freq\"];\n" -" if ($docInfo[$i][\"hi\"])\n" -" {\n" -" $statInfo[\"docs\"][$i][\"rank\"]=\n" -" (float)($freq*$multiplier+$totalFreqLo)/$totalFreq;\n" -" }\n" -" else\n" -" {\n" -" $statInfo[\"docs\"][$i][\"rank\"]=\n" -" (float)($freq*$multiplier)/$totalFreq;\n" -" }\n" -" }\n" -" }\n" -" }\n" -" }\n" -" return $statsList;\n" -"}\n" -"\n" -"function combine_results($results,&$docs)\n" -"{\n" -" foreach ($results as $wordInfo)\n" -" {\n" -" $docsList = &$wordInfo[\"docs\"];\n" -" foreach ($docsList as $di)\n" -" {\n" -" $key=$di[\"url\"];\n" -" $rank=$di[\"rank\"];\n" -" if (in_array($key, array_keys($docs)))\n" -" {\n" -" $docs[$key][\"rank\"]+=$rank;\n" -" }\n" -" else\n" -" {\n" -" $docs[$key] = array(\"url\"=>$key,\n" -" \"name\"=>$di[\"name\"],\n" -" \"rank\"=>$rank\n" -" );\n" -" }\n" -" $docs[$key][\"words\"][] = array(\n" -" \"word\"=>$wordInfo[\"word\"],\n" -" \"match\"=>$wordInfo[\"match\"],\n" -" \"freq\"=>$di[\"freq\"]\n" -" );\n" -" }\n" -" }\n" -" return $docs;\n" -"}\n" -"\n" -"function filter_results($docs,&$requiredWords,&$forbiddenWords)\n" -"{\n" -" $filteredDocs=array();\n" -" while (list ($key, $val) = each ($docs)) \n" -" {\n" -" $words = &$docs[$key][\"words\"];\n" -" $copy=1; // copy entry by default\n" -" if (sizeof($requiredWords)>0)\n" -" {\n" -" foreach ($requiredWords as $reqWord)\n" -" {\n" -" $found=0;\n" -" foreach ($words as $wordInfo)\n" -" { \n" -" $found = $wordInfo[\"word\"]==$reqWord;\n" -" if ($found) break;\n" -" }\n" -" if (!$found) \n" -" {\n" -" $copy=0; // document contains none of the required words\n" -" break;\n" -" }\n" -" }\n" -" }\n" -" if (sizeof($forbiddenWords)>0)\n" -" {\n" -" foreach ($words as $wordInfo)\n" -" {\n" -" if (in_array($wordInfo[\"word\"],$forbiddenWords))\n" -" {\n" -" $copy=0; // document contains a forbidden word\n" -" break;\n" -" }\n" -" }\n" -" }\n" -" if ($copy) $filteredDocs[$key]=$docs[$key];\n" -" }\n" -" return $filteredDocs;\n" -"}\n" -"\n" -"function compare_rank($a,$b)\n" -"{\n" -" if ($a[\"rank\"] == $b[\"rank\"]) \n" -" {\n" -" return 0;\n" -" }\n" -" return ($a[\"rank\"]>$b[\"rank\"]) ? -1 : 1; \n" -"}\n" -"\n" -"function sort_results($docs,&$sorted)\n" -"{\n" -" $sorted = $docs;\n" -" usort($sorted,\"compare_rank\");\n" -" return $sorted;\n" -"}\n" -"\n" -"function report_results(&$docs)\n" -"{\n" -" echo \"<table cellspacing=\\\"2\\\">\\n\";\n" -" echo \" <tr>\\n\";\n" -" echo \" <td colspan=\\\"2\\\"><h2>\".search_results().\"</h2></td>\\n\";\n" -" echo \" </tr>\\n\";\n" -" $numDocs = sizeof($docs);\n" -" if ($numDocs==0)\n" -" {\n" -" echo \" <tr>\\n\";\n" -" echo \" <td colspan=\\\"2\\\">\".matches_text(0).\"</td>\\n\";\n" -" echo \" </tr>\\n\";\n" -" }\n" -" else\n" -" {\n" -" echo \" <tr>\\n\";\n" -" echo \" <td colspan=\\\"2\\\">\".matches_text($numDocs);\n" -" echo \"\\n\";\n" -" echo \" </td>\\n\";\n" -" echo \" </tr>\\n\";\n" -" $num=1;\n" -" foreach ($docs as $doc)\n" -" {\n" -" echo \" <tr>\\n\";\n" -" echo \" <td align=\\\"right\\\">$num.</td>\";\n" -" echo \"<td><a class=\\\"el\\\" href=\\\"\".$doc[\"url\"].\"\\\">\".$doc[\"name\"].\"</a></td>\\n\";\n" -" echo \" <tr>\\n\";\n" -" echo \" <td></td><td class=\\\"tiny\\\">\".report_matches().\" \";\n" -" foreach ($doc[\"words\"] as $wordInfo)\n" -" {\n" -" $word = $wordInfo[\"word\"];\n" -" $matchRight = substr($wordInfo[\"match\"],strlen($word));\n" -" echo \"<b>$word</b>$matchRight(\".$wordInfo[\"freq\"].\") \";\n" -" }\n" -" echo \" </td>\\n\";\n" -" echo \" </tr>\\n\";\n" -" $num++;\n" -" }\n" -" }\n" -" echo \"</table>\\n\";\n" -"}\n" -"\n" -"function main()\n" -"{\n" -" if(strcmp('4.1.0', phpversion()) > 0) \n" -" {\n" -" die(\"Error: PHP version 4.1.0 or above required!\");\n" -" }\n" -" if (!($file=fopen(\"search.idx\",\"rb\"))) \n" -" {\n" -" die(\"Error: Search index file could NOT be opened!\");\n" -" }\n" -" if (readHeader($file)!=\"DOXS\")\n" -" {\n" -" die(\"Error: Header of index file is invalid!\");\n" -" }\n" -" $query=\"\";\n" -" if (array_key_exists(\"query\", $_GET))\n" -" {\n" -" $query=$_GET[\"query\"];\n" -" }\n" -" end_form(ereg_replace(\"[^[:alnum:]:\\\\.\\\\t ]\", \" \", $query ));\n" -" echo \" \\n<div class=\\\"searchresults\\\">\\n\";\n" -" $results = array();\n" -" $requiredWords = array();\n" -" $forbiddenWords = array();\n" -" $foundWords = array();\n" -" $word=strtok($query,\" \");\n" -" while ($word) // for each word in the search query\n" -" {\n" -" if (($word{0}=='+')) { $word=substr($word,1); $requiredWords[]=$word; }\n" -" if (($word{0}=='-')) { $word=substr($word,1); $forbiddenWords[]=$word; }\n" -" if (!in_array($word,$foundWords))\n" -" {\n" -" $foundWords[]=$word;\n" -" search($file,strtolower($word),$results);\n" -" }\n" -" $word=strtok(\" \");\n" -" }\n" -" $docs = array();\n" -" combine_results($results,$docs);\n" -" // filter out documents with forbidden word or that do not contain\n" -" // required words\n" -" $filteredDocs = filter_results($docs,$requiredWords,$forbiddenWords);\n" -" // sort the results based on rank\n" -" $sorted = array();\n" -" sort_results($filteredDocs,$sorted);\n" -" // report results to the user\n" -" report_results($sorted);\n" -" echo \"</div>\\n\";\n" -" fclose($file);\n" -"}\n" -"\n" -"main();\n" -"\n" diff --git a/src/sortdict.h b/src/sortdict.h index ddabdcd..d2b3720 100644 --- a/src/sortdict.h +++ b/src/sortdict.h @@ -106,6 +106,8 @@ class SDict /*! Create an ordered dictionary. * \param size The size of the dictionary. Should be a prime number for * best distribution of elements. + * \param caseSensitive indicated whether the keys should be sorted + * in a case sensitive way. */ SDict(int size,bool caseSensitive=TRUE) : m_sizeIndex(0) { diff --git a/src/translator.h b/src/translator.h index a9ec6ea..88e0113 100644 --- a/src/translator.h +++ b/src/translator.h @@ -476,6 +476,16 @@ class Translator virtual QCString trSubprogram(bool first_capital, bool singular) = 0; virtual QCString trTypeConstraints() = 0; +////////////////////////////////////////////////////////////////////////// +// new since 1.6.0 +////////////////////////////////////////////////////////////////////////// + + virtual QCString trDirRelation(const char *name) = 0; + virtual QCString trLoading() = 0; + virtual QCString trGlobalNamespace() = 0; + virtual QCString trSearching() = 0; + virtual QCString trNoMatches() = 0; + }; #endif diff --git a/src/translator_adapter.h b/src/translator_adapter.h index a73da00..869b25d 100644 --- a/src/translator_adapter.h +++ b/src/translator_adapter.h @@ -41,7 +41,29 @@ class TranslatorAdapterBase : public Translator }; -class TranslatorAdapter_1_5_4 : public TranslatorAdapterBase +class TranslatorAdapter_1_6_0 : public TranslatorAdapterBase +{ + public: + virtual QCString updateNeededMessage() + { return createUpdateNeededMessage(idLanguage(),"release 1.6.0"); } + + virtual QCString trDirRelation(const char *name) + { return english.trDirRelation(name); } + + virtual QCString trLoading() + { return english.trLoading(); } + + virtual QCString trGlobalNamespace() + { return english.trGlobalNamespace(); } + + virtual QCString trSearching() + { return english.trSearching(); } + + virtual QCString trNoMatches() + { return english.trNoMatches(); } +}; + +class TranslatorAdapter_1_5_4 : public TranslatorAdapter_1_6_0 { public: virtual QCString updateNeededMessage() diff --git a/src/translator_br.h b/src/translator_br.h index 7012f40..4742eb4 100644 --- a/src/translator_br.h +++ b/src/translator_br.h @@ -34,7 +34,7 @@ #ifndef TRANSLATOR_BR_H #define TRANSLATOR_BR_H -class TranslatorBrazilian : public Translator +class TranslatorBrazilian : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_ca.h b/src/translator_ca.h index da3940e..705ab3d 100644 --- a/src/translator_ca.h +++ b/src/translator_ca.h @@ -40,7 +40,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorCatalan : public Translator +class TranslatorCatalan : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_cn.h b/src/translator_cn.h index 0648c6a..2260c63 100644 --- a/src/translator_cn.h +++ b/src/translator_cn.h @@ -24,7 +24,7 @@ */ #define CN_SPC -class TranslatorChinese : public Translator +class TranslatorChinese : public TranslatorAdapter_1_6_0 { public: /*! Used for identification of the language. The identification diff --git a/src/translator_cz.h b/src/translator_cz.h index 1694d70..cd02dac 100644 --- a/src/translator_cz.h +++ b/src/translator_cz.h @@ -77,7 +77,7 @@ // something else. It is difficult to find the general translation // for all kinds in the Czech language. -class TranslatorCzech : public Translator +class TranslatorCzech : public TranslatorAdapter_1_6_0 { public: // --- Language control methods ------------------- diff --git a/src/translator_de.h b/src/translator_de.h index e9f55f6..096cf39 100644 --- a/src/translator_de.h +++ b/src/translator_de.h @@ -123,7 +123,7 @@ #ifndef TRANSLATOR_DE_H #define TRANSLATOR_DE_H -class TranslatorGerman : public Translator +class TranslatorGerman : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_en.h b/src/translator_en.h index c71957e..423b78c 100644 --- a/src/translator_en.h +++ b/src/translator_en.h @@ -1728,6 +1728,7 @@ class TranslatorEnglish : public Translator if (!singular) result+="s"; return result; } + /*! This is put at the bottom of a module documentation page and is * followed by a list of files that were used to generate the page. */ @@ -1750,6 +1751,7 @@ class TranslatorEnglish : public Translator if (single) result+=":"; else result+="s:"; return result; } + /*! This is used for translation of the word that will possibly * be followed by a single name or by a list of names * of the category. @@ -1760,6 +1762,7 @@ class TranslatorEnglish : public Translator if (!singular) result+="s"; return result; } + /*! This is used for translation of the word that will possibly * be followed by a single name or by a list of names * of the category. @@ -1777,6 +1780,40 @@ class TranslatorEnglish : public Translator return "Type Constraints"; } +////////////////////////////////////////////////////////////////////////// +// new since 1.6.0 (mainly for the new search engine) +////////////////////////////////////////////////////////////////////////// + + /*! directory relation for \a name */ + virtual QCString trDirRelation(const char *name) + { + return QCString(name)+" Relation"; + } + + /*! Loading message shown when loading search results */ + virtual QCString trLoading() + { + return "Loading..."; + } + + /*! Label used for search results in the global namespace */ + virtual QCString trGlobalNamespace() + { + return "Global Namespace"; + } + + /*! Message shown while searching */ + virtual QCString trSearching() + { + return "Searching..."; + } + + /*! Text shown when no search results are found */ + virtual QCString trNoMatches() + { + return "No Matches"; + } + }; #endif diff --git a/src/translator_eo.h b/src/translator_eo.h index 9cdd142..ae9e209 100644 --- a/src/translator_eo.h +++ b/src/translator_eo.h @@ -40,7 +40,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorEsperanto : public Translator +class TranslatorEsperanto : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_es.h b/src/translator_es.h index d8342ac..7c38e16 100644 --- a/src/translator_es.h +++ b/src/translator_es.h @@ -29,7 +29,7 @@ #ifndef TRANSLATOR_ES_H #define TRANSLATOR_ES_H -class TranslatorSpanish : public Translator +class TranslatorSpanish : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_fa.h b/src/translator_fa.h index 588b5d4..5a47ef4 100644 --- a/src/translator_fa.h +++ b/src/translator_fa.h @@ -32,7 +32,7 @@ #define HtmlDivEnd QCString("</div>") -class TranslatorPersian : public Translator +class TranslatorPersian : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_fi.h b/src/translator_fi.h index 4a11d4c..709f370 100644 --- a/src/translator_fi.h +++ b/src/translator_fi.h @@ -86,7 +86,7 @@ positiiviset kommentit otetaan ilolla vastaan. #ifndef TRANSLATOR_FI_H #define TRANSLATOR_FI_H -class TranslatorFinnish : public Translator +class TranslatorFinnish : public TranslatorAdapter_1_6_0 { public: /*! This method is used to generate a warning message to signal diff --git a/src/translator_hr.h b/src/translator_hr.h index ac8ad7b..f04ac97 100644 --- a/src/translator_hr.h +++ b/src/translator_hr.h @@ -74,7 +74,7 @@ #ifndef TRANSLATOR_HR_H #define TRANSLATOR_HR_H -class TranslatorCroatian : public Translator +class TranslatorCroatian : public TranslatorAdapter_1_6_0 { private: /*! to avoid macro redefinition from translator_cz.h */ diff --git a/src/translator_it.h b/src/translator_it.h index 6f80b22..329dd1f 100644 --- a/src/translator_it.h +++ b/src/translator_it.h @@ -80,7 +80,7 @@ #ifndef TRANSLATOR_IT_H #define TRANSLATOR_IT_H -class TranslatorItalian : public Translator +class TranslatorItalian : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_jp.h b/src/translator_jp.h index 76bd6ea..223cea0 100644 --- a/src/translator_jp.h +++ b/src/translator_jp.h @@ -32,7 +32,7 @@ #ifndef TRANSLATOR_JP_H #define TRANSLATOR_JP_H -class TranslatorJapanese : public Translator +class TranslatorJapanese : public TranslatorAdapter_1_6_0 { private: /*! The decode() can change euc into sjis */ diff --git a/src/translator_kr.h b/src/translator_kr.h index e97cc7b..dbc72e8 100644 --- a/src/translator_kr.h +++ b/src/translator_kr.h @@ -50,7 +50,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorKorean : public Translator +class TranslatorKorean : public TranslatorAdapter_1_6_0 { protected: friend class TranslatorAdapterBase; diff --git a/src/translator_mk.h b/src/translator_mk.h index 49ab516..c8a3697 100644 --- a/src/translator_mk.h +++ b/src/translator_mk.h @@ -32,7 +32,7 @@ #ifndef TRANSLATOR_MK_H #define TRANSLATOR_MK_H -class TranslatorMacedonian : public Translator +class TranslatorMacedonian : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_nl.h b/src/translator_nl.h index d7b61f7..fa3f63e 100644 --- a/src/translator_nl.h +++ b/src/translator_nl.h @@ -74,7 +74,7 @@ class TranslatorDutch : public Translator QCString trGeneratedAutomatically(const char *s) { QCString result="Automatisch gegenereerd door Doxygen"; if (s) result+=(QCString)" voor "+s; - result+=" uit de programmacode."; + result+=" uit de programmatekst."; return result; } QCString trEnumName() @@ -109,7 +109,7 @@ class TranslatorDutch : public Translator { QCString result="Hieronder volgt de lijst met alle "; if (!extractAll) result+="gedocumenteerde "; - result+="files, elk met een korte beschrijving:"; + result+="bestanden, elk met een korte beschrijving:"; return result; } QCString trCompoundListDescription() @@ -129,9 +129,9 @@ class TranslatorDutch : public Translator { QCString result="Hieronder volgt de lijst met alle "; if (!extractAll) result+="gedocumenteerde "; - result+="file members met links naar "; - if (extractAll) result+="de file documentatie voor elke member:"; - else result+="de files waartoe ze behoren:"; + result+="bestand members met links naar "; + if (extractAll) result+="de bestand's documentatie voor elke member:"; + else result+="de bestanden waartoe ze behoren:"; return result; } QCString trExamplesDescription() @@ -279,7 +279,7 @@ class TranslatorDutch : public Translator // used as the title of the HTML page of a file { QCString result=fileName; - result+=" File Referentie"; + result+=" Bestand Referentie"; return result; } QCString trNamespaceReference(const char *namespaceName) @@ -420,7 +420,7 @@ class TranslatorDutch : public Translator case ClassDef::Category: result+="deze categorie"; break; case ClassDef::Exception: result+="deze exceptie"; break; } - result+=" is gegenereerd op grond van de volgende file"; + result+=" is gegenereerd op grond van het volgende bestand"; if (single) result+=":"; else result+="s:"; return result; } @@ -456,11 +456,11 @@ class TranslatorDutch : public Translator QCString trDefinedAtLineInSourceFile() { - return "De definitie bevindt zich op regel @0 in de file @1."; + return "De definitie bevindt zich op regel @0 in het bestand @1."; } QCString trDefinedInSourceFile() { - return "De definitie bevindt zich in de file @0."; + return "De definitie bevindt zich in het bestand @0."; } ////////////////////////////////////////////////////////////////////////// @@ -494,12 +494,12 @@ class TranslatorDutch : public Translator /*! Used in the file documentation to point to the corresponding sources. */ QCString trGotoSourceCode() { - return "Ga naar de bron code van deze file."; + return "Ga naar de broncode van dit bestand."; } /*! Used in the file sources to point to the corresponding documentation. */ QCString trGotoDocumentation() { - return "Ga naar de documentatie van deze file."; + return "Ga naar de documentatie van dit bestand."; } /*! Text for the \\pre command */ QCString trPrecondition() @@ -622,8 +622,8 @@ class TranslatorDutch : public Translator } QCString trInclByDepGraph() { - return "Deze graaf geeft aan welke files direct of " - "indirect afhankelijk zijn van deze file:"; + return "Deze graaf geeft aan welke bestanden direct of " + "indirect afhankelijk zijn van dit bestand:"; } QCString trSince() { @@ -863,8 +863,8 @@ class TranslatorDutch : public Translator */ virtual QCString trFile(bool first_capital, bool singular) { - QCString result((first_capital ? "File" : "file")); - if (!singular) result+="s"; + QCString result((first_capital ? "Bestand" : "bestand")); + if (!singular) result+="en"; return result; } @@ -1342,7 +1342,7 @@ class TranslatorDutch : public Translator case ClassDef::Category: result+="deze category"; break; case ClassDef::Exception: result+="deze exception"; break; } - result+=" is gegenereerd op grond van de volgende file"; + result+=" is gegenereerd op grond van het volgende bestand"; if (single) result+=":"; else result+="s:"; return result; } @@ -1372,6 +1372,43 @@ class TranslatorDutch : public Translator { return "Type Beperkingen"; } + +////////////////////////////////////////////////////////////////////////// +// new since 1.6.0 +////////////////////////////////////////////////////////////////////////// + + /*! directory relation for \a name */ + virtual QCString trDirRelation(const char *name) + { + return QCString(name)+" Relatie"; + } + + /*! Loading message shown when loading search results */ + virtual QCString trLoading() + { + return "Laden..."; + } + + /*! Label used for search results in the global namespace */ + virtual QCString trGlobalNamespace() + { + return "Globale Namespace"; + } + + /*! Message shown while searching */ + virtual QCString trSearching() + { + return "Zoeken..."; + } + + /*! Text shown when no search results are found */ + virtual QCString trNoMatches() + { + return "Niets gevonden"; + } + + + }; #endif diff --git a/src/translator_pl.h b/src/translator_pl.h index bddd7ff..571966c 100644 --- a/src/translator_pl.h +++ b/src/translator_pl.h @@ -20,7 +20,7 @@ #ifndef TRANSLATOR_PL_H #define TRANSLATOR_PL_H -class TranslatorPolish : public Translator +class TranslatorPolish : public TranslatorAdapter_1_6_0 { private: /*! to avoid macro redefinition from translator_pl.h */ diff --git a/src/translator_ro.h b/src/translator_ro.h index dae3ae8..9ee8007 100644 --- a/src/translator_ro.h +++ b/src/translator_ro.h @@ -41,7 +41,7 @@ #define TRANSLATOR_RO_H -class TranslatorRomanian : public Translator +class TranslatorRomanian : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_ru.h b/src/translator_ru.h index 96047a5..c34c189 100644 --- a/src/translator_ru.h +++ b/src/translator_ru.h @@ -26,7 +26,7 @@ #ifndef TRANSLATOR_RU_H #define TRANSLATOR_RU_H -class TranslatorRussian : public Translator +class TranslatorRussian : public TranslatorAdapter_1_6_0 { public: /*! Used for identification of the language. */ diff --git a/src/translator_sc.h b/src/translator_sc.h index 1439e82..4e84990 100644 --- a/src/translator_sc.h +++ b/src/translator_sc.h @@ -40,7 +40,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorSerbianCyrilic : public Translator +class TranslatorSerbianCyrilic : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_sr.h b/src/translator_sr.h index 338bedf..9bd5d1d 100644 --- a/src/translator_sr.h +++ b/src/translator_sr.h @@ -24,7 +24,7 @@ // UTF-8 patch by Nenad Bulatovic <buletina@gmail.com> // translation update by Andrija M. Bosnjakovic <andrija@etf.bg.ac.yu> -class TranslatorSerbian : public Translator +class TranslatorSerbian : public TranslatorAdapter_1_6_0 { private: QCString decode(const QCString& sInput) diff --git a/src/translator_sv.h b/src/translator_sv.h index d5ee58c..d3228b3 100644 --- a/src/translator_sv.h +++ b/src/translator_sv.h @@ -69,7 +69,7 @@ Problem! #ifndef TRANSLATOR_SE_H #define TRANSLATOR_SE_H -class TranslatorSwedish : public Translator +class TranslatorSwedish : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_tr.h b/src/translator_tr.h index 131e1c4..c425fb4 100644 --- a/src/translator_tr.h +++ b/src/translator_tr.h @@ -40,7 +40,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorTurkish : public Translator +class TranslatorTurkish : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_tw.h b/src/translator_tw.h index ae5eef0..c3f665a 100644 --- a/src/translator_tw.h +++ b/src/translator_tw.h @@ -41,7 +41,7 @@ // Translator class (by the local maintainer) when the localized // translator is made up-to-date again. -class TranslatorChinesetraditional : public Translator +class TranslatorChinesetraditional : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translator_vi.h b/src/translator_vi.h index 163c69a..900924e 100644 --- a/src/translator_vi.h +++ b/src/translator_vi.h @@ -47,7 +47,7 @@ Translator class (by the local maintainer) when the localized translator is made up-to-date again. */ -class TranslatorVietnamese : public Translator +class TranslatorVietnamese : public TranslatorAdapter_1_6_0 { public: diff --git a/src/translatordecoder.h b/src/translatordecoder.h index 4614863..be1c99a 100644 --- a/src/translatordecoder.h +++ b/src/translatordecoder.h @@ -707,6 +707,20 @@ class TranslatorDecoder : public Translator QCString trTypeConstraints() { return toUtf8(m_translator->trTypeConstraints()); } +////////////////////////////////////////////////////////////////////////// +// new since 1.6.0 +////////////////////////////////////////////////////////////////////////// + + QCString trDirRelation(const char *name) + { return toUtf8(m_translator->trDirRelation(fromUtf8(name))); } + QCString trLoading() + { return toUtf8(m_translator->trLoading()); } + QCString trGlobalNamespace() + { return toUtf8(m_translator->trGlobalNamespace()); } + QCString trSearching() + { return toUtf8(m_translator->trSearching()); } + QCString trNoMatches() + { return toUtf8(m_translator->trNoMatches()); } ////////////////////////////////////////////////////////////////////////// private: diff --git a/src/util.cpp b/src/util.cpp index d6519c4..d349b8d 100644 --- a/src/util.cpp +++ b/src/util.cpp @@ -3135,7 +3135,12 @@ static QCString getCanonicalTypeForIdentifier( //printf(" mtype=%s\n",mType?mType->name().data():"<none>"); - if (cd) // resolves to a known class type + if (cd && cd==d) + { + *tSpec=""; + return ""; + } + else if (cd) // resolves to a known class type { if (mType && mType->isTypedef()) // but via a typedef { @@ -3217,9 +3222,10 @@ static QCString extractCanonicalType(Definition *d,FileDef *fs,QCString type) //printf("extractCanonicalType(type=%s) start: def=%s file=%s\n",type.data(), // d ? d->name().data() : "<null>",fs ? fs->name().data() : "<null>"); - static QRegExp id("[a-z_A-Z\\x80-\\xFF][:a-z_A-Z0-9\\x80-\\xFF]*"); + //static QRegExp id("[a-z_A-Z\\x80-\\xFF][:a-z_A-Z0-9\\x80-\\xFF]*"); - QCString canType,templSpec,word; + QCString canType; + QCString templSpec,word; int i,p=0,pp=0; while ((i=extractClassNameFromType(type,p,word,templSpec))!=-1) // foreach identifier in the type @@ -3228,7 +3234,19 @@ static QCString extractCanonicalType(Definition *d,FileDef *fs,QCString type) if (i>pp) canType += type.mid(pp,i-pp); - canType += getCanonicalTypeForIdentifier(d,fs,word,&templSpec); + QCString ct = getCanonicalTypeForIdentifier(d,fs,word,&templSpec); + + // in case the ct is empty it means that "word" represents scope "d" + // and this does not need to be added to the canonical + // type (it is redundant), so/ we skip it. This solves problem 589616. + if (ct.isEmpty() && type.mid(p,2)=="::") + { + p+=2; + } + else + { + canType += ct; + } //printf(" word=%s templSpec=%s canType=%s\n",word.data(),templSpec.data(),canType.data()); if (!templSpec.isEmpty()) // if we didn't use up the templSpec already // (i.e. type is not a template specialization) @@ -3259,7 +3277,7 @@ static QCString extractCanonicalArgType(Definition *d,FileDef *fs,const Argument { QCString type = arg->type.stripWhiteSpace(); QCString name = arg->name; - //printf("extractCanonicalArgType(type=%s,name=%s)\n",type.data(),name.data()); + //printf("----- extractCanonicalArgType(type=%s,name=%s)\n",type.data(),name.data()); if ((type=="const" || type=="volatile") && !name.isEmpty()) { // name is part of type => correct type+=" "; @@ -4252,7 +4270,7 @@ QCString linkToText(const char *link,bool isFileName) return result; } -/*! +/* * generate a reference to a class, namespace or member. * `scName' is the name of the scope that contains the documentation * string that is returned. @@ -5614,10 +5632,10 @@ QCString stripTemplateSpecifiersFromScope(const QCString &fullName, result+=fullName.mid(p,i-p); //printf(" trying %s\n",(result+fullName.mid(i,e-i)).data()); - if (getClass(result+fullName.mid(i,e-i))!=0) + if (getClass(result+fullName.mid(i,e-i))!=0) { result+=fullName.mid(i,e-i); - //printf("2:result+=%s\n",fullName.mid(i,e-i-1).data()); + //printf(" 2:result+=%s cd=%s\n",fullName.mid(i,e-i-1).data(),cd->name().data()); } else if (pLastScopeStripped) { @@ -5827,8 +5845,8 @@ void addRefItem(const QList<ListItemInfo> *sli, { RefItem *item = refList->getRefItem(lii->itemId); ASSERT(item!=0); - //printf("anchor=%s written=%d\n",item->listAnchor.data(),item->written); - if (item->written) return; + printf("anchor=%s written=%d\n",item->listAnchor.data(),item->written); + //if (item->written) return; QCString doc(1000); doc = "\\anchor "; @@ -5845,7 +5863,7 @@ void addRefItem(const QList<ListItemInfo> *sli, doc += item->text; doc += "</dd></dl>\n"; addRelatedPage(refList->listName(),refList->pageTitle(),doc,0,refList->listName(),1,0,0,0); - item->written=TRUE; + //item->written=TRUE; } } } diff --git a/src/vhdlcode.l b/src/vhdlcode.l index a7f0d7f..42e657d 100644 --- a/src/vhdlcode.l +++ b/src/vhdlcode.l @@ -60,7 +60,6 @@ static bool isFuncProto=FALSE; static bool isComponent=FALSE; static bool isPackageBody=FALSE; static bool isProto = FALSE; -static bool isStripCode = FALSE; static QCString g_PrevString; static QCString g_CurrClass; @@ -127,7 +126,7 @@ static void setCurrentDoc(const QCString &name,const QCString &base,const QCStri static bool checkString(QCString &name) { if (name.isEmpty()) return FALSE; - static QRegExp regg("[ \t\"]"); + static QRegExp regg("[\\s\"]"); int len=name.length(); if (name.at(0)=='"' && name.at(len-1)=='"' && len > 2) @@ -337,7 +336,8 @@ static void writeWord(const char *word,const char* curr_class=0,bool classLink=F */ static void codifyLines(const char *text,const char *cl=0,bool classlink=FALSE) { - // printf("codifyLines(%d,\"%s\")\n",g_yyLineNr,text); + if (text==0) return; + printf("codifyLines(%d,\"%s\")\n",g_yyLineNr,text); const char *p=text,*sp=p; char c; bool done=FALSE; @@ -578,7 +578,8 @@ static void startFontClass(const char *s) static void writeFont(const char *s,const char* text) { - if (s==0) return; + if (s==0 || text==0) return; + printf("writeFont(%d,\"%s\")\n",g_yyLineNr,text); g_code->startFontClass(s); g_code->codify(text); g_code->endFontClass(); @@ -605,7 +606,7 @@ static QCString g_temp; /* writes and links a port map statement */ static void codifyMapLines(char *text) { - if (text==NULL) return; + if (text==0) return; g_temp.resize(0); //bool dot=FALSE; int wordCounter=0; @@ -873,9 +874,6 @@ MAPCOMPONENT4 ({ALLTYPESMAP}[:]{BN}*("entity"|"component"|"configuration"){BN}+{ } BEGIN(Map); } -<Map>{TEXTT} { - writeFont("keyword",vhdlcodeYYtext); - } <Map>"\n"|"," { codifyLines(vhdlcodeYYtext); @@ -924,24 +922,22 @@ MAPCOMPONENT4 ({ALLTYPESMAP}[:]{BN}*("entity"|"component"|"configuration"){BN}+{ <ParseType>{TEXTT} { - if (!isStripCode) - { - g_FuncProto.append(vhdlcodeYYtext); - if (isProto) - { - writeFont("keyword",vhdlcodeYYtext); - } - BEGIN(ParseType); - } + g_FuncProto.append(vhdlcodeYYtext); + if (isProto) + { + writeFont("keyword",vhdlcodeYYtext); + } + BEGIN(ParseType); } <ParseType>{ENDEFUNC} { + QRegExp regg("[\\s]"); QCString tt(vhdlcodeYYtext); codifyLines(vhdlcodeYYtext,g_CurrClass.data()); tt=tt.lower(); VhdlDocGen::deleteAllChars(tt,';'); tt.stripWhiteSpace(); - QStringList ql=QStringList::split(" ",tt,FALSE); + QStringList ql=QStringList::split(regg,tt,FALSE); int index=ql.findIndex(QCString("if"))+1; index+=ql.findIndex(QCString("case"))+1; index+=ql.findIndex(QCString("loop"))+1; @@ -1097,23 +1093,8 @@ MAPCOMPONENT4 ({ALLTYPESMAP}[:]{BN}*("entity"|"component"|"configuration"){BN}+{ <ParseComponent>"\n"|" " { - if (!isStripCode) - { codifyLines(vhdlcodeYYtext); - } - else - { - g_yyLineNr++; - } - } - -<ParseComponent>{TEXTT} { - QCString text(vhdlcodeYYtext); - if (!isStripCode) - { - writeFont("keyword",vhdlcodeYYtext); } - } <ParseComponent>{DIGITSS} { startFontClass("vhdllogic"); @@ -1446,14 +1427,7 @@ MAPCOMPONENT4 ({ALLTYPESMAP}[:]{BN}*("entity"|"component"|"configuration"){BN}+{ } <*>\n { - if (!isStripCode) - { - codifyLines(vhdlcodeYYtext); - } - else - { - g_yyLineNr++; - } + codifyLines(vhdlcodeYYtext); BEGIN(Bases); } @@ -1461,33 +1435,36 @@ MAPCOMPONENT4 ({ALLTYPESMAP}[:]{BN}*("entity"|"component"|"configuration"){BN}+{ g_code->codify(vhdlcodeYYtext); } -<*>{TEXTT} { // found text - bool stripLine=FALSE; +<*>\n{TEXTT} { // found normal or special comment on its own line QCString text(vhdlcodeYYtext); - if (Config_getBool("STRIP_CODE_COMMENTS")) - { - if (text.contains("--!")) - { - stripLine=TRUE; - } + int i=text.find("--"); + if (text.mid(i,3)=="--!" && // hide special comment + Config_getBool("STRIP_CODE_COMMENTS")) + { + g_yyLineNr++; // skip complete line } - if (!isStripCode && !stripLine) + else // normal comment { - writeFont("keyword",vhdlcodeYYtext); - BEGIN(Bases); + startFontClass("comment"); + codifyLines(text); + endFontClass(); } } - /* -<*>{B}*"--#"[^\n]* { // found one line comment - if (!Config_getBool("STRIP_CODE_COMMENTS")) - { - startFontClass("keyword"); - codifyLines(vhdlcodeYYtext); - endFontClass(); - } +<*>{TEXTT} { // found normal or special comment after something + QCString text(vhdlcodeYYtext); + int i=text.find("--"); + if (text.mid(i,3)=="--!" && + Config_getBool("STRIP_CODE_COMMENTS")) + { + // hide special comment + } + else // normal comment + { + startFontClass("comment"); + codifyLines(text); + endFontClass(); + } } - */ - %% diff --git a/src/vhdldocgen.cpp b/src/vhdldocgen.cpp index ad5f8df..27c2fa7 100644 --- a/src/vhdldocgen.cpp +++ b/src/vhdldocgen.cpp @@ -854,7 +854,7 @@ bool VhdlDocGen::getSigName(QList<QCString>& ql, const char* str,QCString& buffer) { int j,ll,index; - char *signal = "signal "; + const char *signal = "signal "; QCString qmem; QCString temp(str); QCString st(str); @@ -1123,7 +1123,9 @@ void VhdlDocGen::getFuncParams(QList<Argument>& ql, const char* str) uint zui=ttype.contains('(',FALSE); if (zui == 0) - tt=QStringList::split(" ",ttype,FALSE); + { + tt=QStringList::split(QRegExp("[\\s]"),ttype,FALSE); + } else { if (ttype.stripPrefix("in")) @@ -1165,7 +1167,7 @@ void VhdlDocGen::getFuncParams(QList<Argument>& ql, const char* str) QCString name=(QCString)tempList[j]; name=name.stripWhiteSpace(); - tt=QStringList::split(" ",name,FALSE); + tt=QStringList::split(QRegExp("[\\s]"),name,FALSE); if (tt.count() > 1) ttype=(tt.first()).stripWhiteSpace(); @@ -2114,7 +2116,9 @@ void VhdlDocGen::writeVHDLDeclaration(MemberDef* mdef,OutputList &ol, if (!mdef->briefDescription().isEmpty() && Config_getBool("BRIEF_MEMBER_DESC") /* && !annMemb */) { ol.startMemberDescription(); - ol.parseDoc(mdef->briefFile(),mdef->briefLine(),mdef->getOuterScope()?mdef->getOuterScope():d,mdef,mdef->briefDescription(),TRUE,FALSE); + ol.parseDoc(mdef->briefFile(),mdef->briefLine(), + mdef->getOuterScope()?mdef->getOuterScope():d, + mdef,mdef->briefDescription(),TRUE,FALSE,0,TRUE,FALSE); if (detailsVisible) { ol.pushGeneratorState(); @@ -2228,7 +2232,7 @@ void VhdlDocGen::writeVHDLDeclarations(MemberList* ml,OutputList &ol, if (subtitle && subtitle[0]!=0) { ol.startMemberSubtitle(); - ol.parseDoc("[generated]",-1,0,0,subtitle,FALSE,FALSE); + ol.parseDoc("[generated]",-1,0,0,subtitle,FALSE,FALSE,0,TRUE,FALSE); ol.endMemberSubtitle(); } //printf("memberGroupList=%p\n",memberGroupList); diff --git a/src/vhdlscanner.l b/src/vhdlscanner.l index 8e7b9de..fd0dba4 100644 --- a/src/vhdlscanner.l +++ b/src/vhdlscanner.l @@ -607,10 +607,11 @@ SPECIAL_CHARACTER [#&'()*+,\-\./:;<=>_|] OTHER_SPECIAL_CHARACTER [~!$ยง%?@\[\\\]^{}] BASIC_GRAPHIC_CHARACTER {UPPER_CASE_LETTER}|{DIGIT}|{SPECIAL_CHARACTER}|{SPACE_CHARACTER} GRAPHIC_CHARACTER {BASIC_GRAPHIC_CHARACTER}|{LOWER_CASE_LETTER}|{OTHER_SPECIAL_CHARACTER} +EXTENDED_CHARACTER [\\]{GRAPHIC_CHARACTER}*[\\] -NAME {LETTER}[a-zA-Z0-9_.]* +NAME ({LETTER}[a-zA-Z0-9_.]*)|{EXTENDED_CHARACTER} STRING_LITERAL \"{GRAPHIC_CHARACTER}*\" -FUNCNAME [a-zA-Z"][*+\-_a-zA-Z0-9"\/=<>]* +FUNCNAME ([a-zA-Z"][*+\-_a-zA-Z0-9"\/=<>]*)|{EXTENDED_CHARACTER} DIGITS [0-9]+|[0-9]+"."[0-9]+|[0-9]+"#"[0-9_a-fA-F\+\.]+"#" COMMENT "--"[^\n]* LABELID [a-z_A-Z][^\;]*";"({B}*{COMMENT})* @@ -843,7 +844,7 @@ ENDPROTECEDBODY "end"{BR}+"protected"{BR}+"body"{BR}+{NAME} // lineCount(); QCString type; QCString tt(yytext); - QRegExp regg("[ \n\t:.()-]"); + QRegExp regg("[\\s:.()-]"); QStringList qsl=QStringList::split(regg,tt,false); // consider upper/lower-case letters @@ -1159,7 +1160,7 @@ ENDPROTECEDBODY "end"{BR}+"protected"{BR}+"body"{BR}+{NAME} <ParseType>{ENDE}|{ENDFUNC} { // found end of function|process - QRegExp regg("[ \n\t;]"); + QRegExp regg("[\\s;]"); lineCount(); QCString tt(yytext); tt=tt.lower(); @@ -1191,7 +1192,7 @@ ENDPROTECEDBODY "end"{BR}+"protected"{BR}+"body"{BR}+{NAME} } <ParseFunc>{ENDE3} { - QRegExp regg("[ \n\t;]"); + QRegExp regg("[\\s;]"); lineCount(); QCString tt(yytext); tt=tt.lower(); @@ -1444,7 +1445,7 @@ ENDPROTECEDBODY "end"{BR}+"protected"{BR}+"body"{BR}+{NAME} //printf("pos=%d eol=%d\n",pos,eol); if (eol>=pos+2) { - QRegExp re("\\n[ \\t]*--!"); // comment continuation + QRegExp re("\\n[\\s]*--!"); // comment continuation comment=line.mid(pos+2,eol-pos-2); //printf("Comment: '%s'\n",comment.data()); int p,l; diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp index dd65f5f..3565756 100644 --- a/src/xmlgen.cpp +++ b/src/xmlgen.cpp @@ -654,6 +654,16 @@ static void generateXMLForMember(MemberDef *md,QTextStream &ti,QTextStream &t,De t << " new=\"yes\""; } + if (md->isOptional()) + { + t << " optional=\"yes\""; + } + + if (md->isRequired()) + { + t << " required=\"yes\""; + } + t << " virt=\""; switch (md->virtualness()) { @@ -698,6 +708,15 @@ static void generateXMLForMember(MemberDef *md,QTextStream &ti,QTextStream &t,De t << " settable=\""; if (md->isSettable()) t << "yes"; else t << "no"; t << "\""; + + if (md->isAssign() || md->isCopy() || md->isRetain()) + { + t << " accessor=\""; + if (md->isAssign()) t << "assign"; + else if (md->isCopy()) t << "copy"; + else if (md->isRetain()) t << "retain"; + t << "\""; + } } else if (md->memberType() == MemberDef::Event) { |