diff options
82 files changed, 289 insertions, 84 deletions
diff --git a/addon/doxyparse/doxyparse.1 b/addon/doxyparse/doxyparse.1 index d8530ab..4fecb2f 100644 --- a/addon/doxyparse/doxyparse.1 +++ b/addon/doxyparse/doxyparse.1 @@ -1,6 +1,6 @@ .TH DOXYPARSE "1" "DATE" "doxyparse VERSION" "User Commands" .SH NAME -doxyparse \- parse and dumps informations about the code +doxyparse \- parse and dumps information about the code .SH SYNOPSIS .B doxyparse [\fIsource file\fR...] diff --git a/addon/doxyparse/doxyparse.cpp b/addon/doxyparse/doxyparse.cpp index ee34e3b..6a1886c 100644 --- a/addon/doxyparse/doxyparse.cpp +++ b/addon/doxyparse/doxyparse.cpp @@ -126,7 +126,7 @@ static void printModule(std::string module) { printf(" %s:\n", module.c_str()); } static void printClassInformation(std::string information) { - printf(" informations: %s\n", information.c_str()); + printf(" information: %s\n", information.c_str()); } static void printInheritance(std::string base_class) { printf(" inherits: %s\n", base_class.c_str()); diff --git a/qtools/qdatastream.cpp b/qtools/qdatastream.cpp index 8505dd4..70bcab1 100644 --- a/qtools/qdatastream.cpp +++ b/qtools/qdatastream.cpp @@ -381,7 +381,7 @@ void QDataStream::setByteOrder( int bo ) \fn void QDataStream::setVersion( int v ) Sets the version number of the data serialization format. - In order to accomodate for new functionality, the datastream + In order to accommodate for new functionality, the datastream serialization format of some Qt classes has changed in some versions of Qt. If you want to read data that was created by an earlier version of Qt, or write data that can be read by a program that was compiled with diff --git a/qtools/qdict.doc b/qtools/qdict.doc index d9f6ca5..d2e26c0 100644 --- a/qtools/qdict.doc +++ b/qtools/qdict.doc @@ -52,7 +52,7 @@ The key is used for inserting and looking up an item. QDict has \l QString keys, which are Unicode strings. If you want to use non-Unicode, plain 8-bit \c char* keys, use the QAsciiDict template. - A QDict has the same performace as a QAsciiDict. + A QDict has the same performance as a QAsciiDict. The dictionary has very fast insertion and lookup. diff --git a/qtools/qstring.cpp b/qtools/qstring.cpp index d831cb1..e04a852 100644 --- a/qtools/qstring.cpp +++ b/qtools/qstring.cpp @@ -13670,7 +13670,7 @@ QString &QString::replace( uint index, uint len, const QString &s ) /*! Replaces \a len characters starting at position \a index by - \a slen units ot QChar data from \a s, and returns a reference to the string. + \a slen units to QChar data from \a s, and returns a reference to the string. \sa insert(), remove() */ diff --git a/qtools/qtextcodec.cpp b/qtools/qtextcodec.cpp index bd874bb..842a72d 100644 --- a/qtools/qtextcodec.cpp +++ b/qtools/qtextcodec.cpp @@ -488,7 +488,7 @@ static bool try_locale_list( const char * const locale[], const char * lang ) } // For the probably_koi8_locales we have to look. the standard says -// these are 8859-5, but almsot all Russion users uses KOI8-R and +// these are 8859-5, but almost all Russian users uses KOI8-R and // incorrectly set $LANG to ru_RU. We'll check tolower() to see what // tolower() thinks ru_RU means. diff --git a/qtools/qvaluelist.doc b/qtools/qvaluelist.doc index e4621d5..918d08e 100644 --- a/qtools/qvaluelist.doc +++ b/qtools/qvaluelist.doc @@ -139,7 +139,7 @@ In addition you can search items in the list with the find() function. It exists in a const and a non const version. It starts searching from the beginning of the list, but another flavor of the find() function allows you to specify where searching should start. - If you just want to know wether a certain item is at least once in the list, then you + If you just want to know whether a certain item is at least once in the list, then you can use the contains() function. Since QValueList is value based there is no need to care about deleting elements in the @@ -201,7 +201,7 @@ of this list become invalidated. Since QValueList is highly tuned for performance you wont see warnings if you use invalid iterators, because it is impossible for - an iterator to check wether it is valid or not. + an iterator to check whether it is valid or not. */ /*! @@ -258,16 +258,16 @@ /*! \fn const T& QValueList::operator[] ( uint i ) const Returns a const reference to the item with index \e i in the list. - It is up to you to check wether this item really exists. You can do that easily - with the count() function. However this operator does not check wether \e i + It is up to you to check whether this item really exists. You can do that easily + with the count() function. However this operator does not check whether \e i is in range and will deliver undefined results if it does not exist. */ /*! \fn T& QValueList::operator[] ( uint i ) Returns a reference to the item with index \e i in the list. - It is up to you to check wether this item really exists. You can do that easily - with the count() function. However this operator does not check wether \e i + It is up to you to check whether this item really exists. You can do that easily + with the count() function. However this operator does not check whether \e i is in range and will deliver undefined results if it does not exist. In contrast to the const operator[] you may manipulate the value returned by this operator. @@ -566,7 +566,7 @@ QValueList is highly optimized for performance and memory usage. On the other hand that means that you have to be a bit more careful by what you are doing. QValueList does not know about all its iterators - and the iterators dont even know to which list they belong. That makes + and the iterators don't even know to which list they belong. That makes things fast and slim but a bit dangerous because it is up to you to make sure that iterators you are using are still valid. QListIterator will be able to give warnings while QValueListIterator may end up in an undefined state. @@ -627,7 +627,7 @@ \fn QValueListIterator<T>& QValueListIterator::operator++() Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the end of the list. Incrementing + The iterator can not check whether it reached the end of the list. Incrementing the iterator as returned by end() causes undefined results. */ @@ -635,7 +635,7 @@ \fn QValueListIterator<T> QValueListIterator::operator++(int) Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the end of the list. Incrementing + The iterator can not check whether it reached the end of the list. Incrementing the iterator as returned by end() causes undefined results. */ @@ -643,7 +643,7 @@ \fn QValueListIterator<T>& QValueListIterator::operator--() Prefix -- makes the previous item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the beginning of the list. Decrementing + The iterator can not check whether it reached the beginning of the list. Decrementing the iterator as returned by begin() causes undefined results. */ @@ -651,7 +651,7 @@ \fn QValueListIterator<T> QValueListIterator::operator--(int) Postfix -- makes the previous item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the beginning of the list. Decrementing + The iterator can not check whether it reached the beginning of the list. Decrementing the iterator as returned by begin() causes undefined results. */ @@ -680,7 +680,7 @@ list. It does not allow to modify the values of the list since this would break the const semantics. - For more informations on QValueList iterators see QValueListIterator. + For more information on QValueList iterators see QValueListIterator. \sa QValueListIterator, QValueList */ @@ -733,7 +733,7 @@ \fn QValueListConstIterator<T>& QValueListConstIterator::operator++() Prefix ++ makes the succeeding item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the end of the list. Incrementing + The iterator can not check whether it reached the end of the list. Incrementing the iterator as returned by end() causes undefined results. */ @@ -741,7 +741,7 @@ \fn QValueListConstIterator<T> QValueListConstIterator::operator++(int) Postfix ++ makes the succeeding item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the end of the list. Incrementing + The iterator can not check whether it reached the end of the list. Incrementing the iterator as returned by end() causes undefined results. */ @@ -749,7 +749,7 @@ \fn QValueListConstIterator<T>& QValueListConstIterator::operator--() Prefix -- makes the previous item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the beginning of the list. Decrementing + The iterator can not check whether it reached the beginning of the list. Decrementing the iterator as returned by begin() causes undefined results. */ @@ -757,7 +757,7 @@ \fn QValueListConstIterator<T> QValueListConstIterator::operator--(int) Postfix -- makes the previous item current and returns an iterator pointing to the new current item. - The iterator can not check wether it reached the beginning of the list. Decrementing + The iterator can not check whether it reached the beginning of the list. Decrementing the iterator as returned by begin() causes undefined results. */ diff --git a/qtools/qwaitcondition_unix.cpp b/qtools/qwaitcondition_unix.cpp index d1ff27e..0a6a09b 100644 --- a/qtools/qwaitcondition_unix.cpp +++ b/qtools/qwaitcondition_unix.cpp @@ -67,7 +67,7 @@ class QWaitConditionPrivate code = pthread_cond_wait(&cond, &mutex); if (code == 0 && wakeups == 0) { - // many vendors warn of spurios wakeups from + // many vendors warn of spurious wakeups from // pthread_cond_wait(), especially after signal delivery, // even though POSIX doesn't allow for it... sigh continue; diff --git a/qtools/qxml.cpp b/qtools/qxml.cpp index 806bd42..072997e 100644 --- a/qtools/qxml.cpp +++ b/qtools/qxml.cpp @@ -44,7 +44,7 @@ // NOT REVISED // Error strings for the XML reader -#define XMLERR_OK "no error occured" +#define XMLERR_OK "no error occurred" #define XMLERR_TAGMISMATCH "tag mismatch" #define XMLERR_UNEXPECTEDEOF "unexpected end of file" #define XMLERR_FINISHEDPARSINGWHILENOTEOF "parsing is finished but end of file is not reached" @@ -226,28 +226,28 @@ QString QXmlParseException::message() const return msg; } /*! - Returns the column number the error occured. + Returns the column number the error occurred. */ int QXmlParseException::columnNumber() const { return column; } /*! - Returns the line number the error occured. + Returns the line number the error occurred. */ int QXmlParseException::lineNumber() const { return line; } /*! - Returns the public identifier the error occured. + Returns the public identifier the error occurred. */ QString QXmlParseException::publicId() const { return pub; } /*! - Returns the system identifier the error occured. + Returns the system identifier the error occurred. */ QString QXmlParseException::systemId() const { @@ -403,7 +403,7 @@ void QXmlNamespaceSupport::splitName( const QString& qname, and looking it up among the prefixes currently declared. First parameter is the raw XML 1.0 name to be processed. The second parameter - is a flag wheter the name is the name of an attribute (TRUE) or not (FALSE). + is a flag whether the name is the name of an attribute (TRUE) or not (FALSE). The return values will be stored in the last two parameters as follows: <ul> @@ -1079,7 +1079,7 @@ finished: \fn bool QXmlErrorHandler::error( const QXmlParseException& exception ) A reader might use this function to report a recoverable error. A recoverable - error corresponds to the definiton of "error" in section 1.2 of the XML 1.0 + error corresponds to the definition of "error" in section 1.2 of the XML 1.0 specification. The reader must continue to provide normal parsing events after invoking this @@ -5652,7 +5652,7 @@ parseError: head stands on the first character after the reference. charDataRead is set to FALSE if the reference must be parsed. The - charachter(s) which the reference mapped to are inserted at the reference + character(s) which the reference mapped to are inserted at the reference position. The head stands on the first character of the replacement). */ bool QXmlSimpleReader::parseReference( bool &charDataRead, EntityRecognitionContext context ) @@ -5943,7 +5943,7 @@ bool QXmlSimpleReader::processReference( bool &charDataRead, EntityRecognitionCo } } else { // "Unparsed" - // ### notify for "Occurs as Attribute Value" missing (but this is no refence, anyway) + // ### notify for "Occurs as Attribute Value" missing (but this is no reference, anyway) // Forbidden d->error = XMLERR_UNPARSEDENTITYREFERENCE; charDataRead = FALSE; diff --git a/src/cite.cpp b/src/cite.cpp index d934d0a..f86350b 100644 --- a/src/cite.cpp +++ b/src/cite.cpp @@ -286,7 +286,7 @@ void CiteDict::generatePage() const thisDir.remove(citeListFile); thisDir.remove(doxygenBstFile); thisDir.remove(bib2xhtmlFile); - // we might try to remove too many files as empty files didn't get a coresponding new file + // we might try to remove too many files as empty files didn't get a corresponding new file // but the remove function does not emit an error for it and we don't catch the error return // so no problem. for (unsigned int j = 1; j <= citeDataList.count(); j++) diff --git a/src/classdef.cpp b/src/classdef.cpp index 07e723b..e1a80ce 100644 --- a/src/classdef.cpp +++ b/src/classdef.cpp @@ -158,7 +158,7 @@ class ClassDefImpl /* user defined member groups */ MemberGroupSDict *memberGroupSDict; - /*! Is this an abstact class? */ + /*! Is this an abstract class? */ bool isAbstract; /*! Is the class part of an unnamed namespace? */ diff --git a/src/commentcnv.l b/src/commentcnv.l index ebee914..44e2543 100644 --- a/src/commentcnv.l +++ b/src/commentcnv.l @@ -667,7 +667,7 @@ void replaceComment(int offset); } } } - /* Python an VHDL share CComment, so special attention for ending commments is required */ + /* Python an VHDL share CComment, so special attention for ending comments is required */ <CComment>"\n"/[ \t]*"#" { if (g_lang!=SrcLangExt_VHDL) { diff --git a/src/commentscan.l b/src/commentscan.l index f26cabd..588d40a 100644 --- a/src/commentscan.l +++ b/src/commentscan.l @@ -1593,7 +1593,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$" /* --------- handle arguments of the file/dir/example command ------------ */ -<FileDocArg1>{DOCNL} { // no file name specfied +<FileDocArg1>{DOCNL} { // no file name specified if (*yytext=='\n') yyLineNr++; addOutput('\n'); BEGIN( Comment ); diff --git a/src/condparser.cpp b/src/condparser.cpp index 69f8d29..6c5d787 100644 --- a/src/condparser.cpp +++ b/src/condparser.cpp @@ -51,7 +51,7 @@ bool CondParser::parse(const char *fileName,int lineNr,const char *expr) #if 0 // check for garbage at the end of the expression - // an expression ends with a character '\0' and token_type = delimeter + // an expression ends with a character '\0' and token_type = delimiter if (m_tokenType!=DELIMITER || !m_token.isEmpty()) { if (m_tokenType == DELIMITER) @@ -84,7 +84,7 @@ bool CondParser::parse(const char *fileName,int lineNr,const char *expr) /** - * checks if the given char c is a delimeter + * checks if the given char c is a delimiter * minus is checked apart, can be unary minus */ static bool isDelimiter(const char c) @@ -155,7 +155,7 @@ void CondParser::getToken() return; } - // check for operators (delimeters) + // check for operators (delimiters) if (isDelimiter(*m_e)) { m_tokenType = DELIMITER; diff --git a/src/config.xml b/src/config.xml index 4d9a048..7bc1fe8 100644 --- a/src/config.xml +++ b/src/config.xml @@ -1644,7 +1644,7 @@ to disable this feature. path to the <a href="http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html"> compilation database</a> used when the files were built. This is equivalent to specifying the "-p" option to a clang tool, such as clang-check. These options - will then be pased to the parser. + will then be passed to the parser. @note The availability of this option depends on whether or not doxygen was generated with the `-Duse-libclang=ON` option for CMake. diff --git a/src/configgen.py b/src/configgen.py index 3b86954..33857b7 100755 --- a/src/configgen.py +++ b/src/configgen.py @@ -63,7 +63,7 @@ def transformDocs(doc): doc = re.sub('<a +href="([^"]*)" *>([^<]*)</a>', '\\2 (see: \\1)', doc) # LaTeX name as formula -> LaTeX doc = doc.replace("\\f$\\mbox{\\LaTeX}\\f$", "LaTeX") - # Other forula's (now just 2) so explicitely mentioned. + # Other formula's (now just 2) so explicitly mentioned. doc = doc.replace("\\f$2^{(16+\\mbox{LOOKUP\\_CACHE\\_SIZE})}\\f$", "2^(16+LOOKUP_CACHE_SIZE)") doc = doc.replace("\\f$2^{16} = 65536\\f$", "2^16=65536") diff --git a/src/context.cpp b/src/context.cpp index de31202..896c4e0 100644 --- a/src/context.cpp +++ b/src/context.cpp @@ -1400,7 +1400,7 @@ class DefinitionContext inst.addProperty("isLinkable",&DefinitionContext::isLinkable); //%% bool isLinkableInProject: can the symbol be linked within this project? inst.addProperty("isLinkableInProject",&DefinitionContext::isLinkableInProject); - //%% int dynSectionId: identifier that can be used for collapsable sections + //%% int dynSectionId: identifier that can be used for collapsible sections inst.addProperty("dynSectionId",&DefinitionContext::dynSectionId); //%% string language: the programming language in which the symbol is written inst.addProperty("language",&DefinitionContext::language); diff --git a/src/docparser.cpp b/src/docparser.cpp index eac6e97..25d4b0c 100644 --- a/src/docparser.cpp +++ b/src/docparser.cpp @@ -6125,9 +6125,20 @@ int DocPara::handleHtmlStartTag(const QCString &tagName,const HtmlAttribList &ta } } } + else if (findAttribute(tagHtmlAttribs,"langword",&cref)) // <see langword="..."/> or <see langworld="..."></see> + { + doctokenizerYYsetStatePara(); + DocLink *lnk = new DocLink(this,cref); + m_children.append(lnk); + QCString leftOver = lnk->parse(FALSE,TRUE); + if (!leftOver.isEmpty()) + { + m_children.append(new DocWord(this,leftOver)); + } + } else { - warn_doc_error(g_fileName,doctokenizerYYlineno,"Missing 'cref' attribute from <see> tag."); + warn_doc_error(g_fileName,doctokenizerYYlineno,"Missing 'cref' or 'langword' attribute from <see> tag."); } } break; diff --git a/src/doxygen.cpp b/src/doxygen.cpp index ec97d43..cf9159c 100644 --- a/src/doxygen.cpp +++ b/src/doxygen.cpp @@ -8403,7 +8403,7 @@ static void flushUnresolvedRelations() // This is needed before resolving the inheritance relations, since // it would otherwise not find the inheritance relation // for C in the example below, as B::I was already found to be unresolvable - // (which is correct if you igore the inheritance relation between A and B). + // (which is correct if you ignore the inheritance relation between A and B). // // class A { class I {} }; // class B : public A {}; diff --git a/src/fortrancode.l b/src/fortrancode.l index 141e762..501b492 100644 --- a/src/fortrancode.l +++ b/src/fortrancode.l @@ -1,6 +1,6 @@ /****************************************************************************** * - * Parser for syntax hightlighting and references for Fortran90 F subset + * Parser for syntax highlighting and references for Fortran90 F subset * * Copyright (C) by Anke Visser * based on the work of Dimitri van Heesch. diff --git a/src/fortranscanner.l b/src/fortranscanner.l index 23c0970..85b6de9 100644 --- a/src/fortranscanner.l +++ b/src/fortranscanner.l @@ -102,8 +102,8 @@ struct SymbolModifiers { bool nopass; bool pass; bool contiguous; - bool volat; /* volatile is a reserverd name */ - bool value; /* volatile is a reserverd name */ + bool volat; /* volatile is a reserved name */ + bool value; /* volatile is a reserved name */ QCString passVar; SymbolModifiers() : type(), returnName(), protection(NONE_P), direction(NONE_D), @@ -1720,7 +1720,7 @@ SymbolModifiers& SymbolModifiers::operator|=(const SymbolModifiers &mdfs) return *this; } -/*! Extracts and adds passed modifier to these modifiers.*/ +/*! Extracts and adds passed modifier to these modifiers.*/ SymbolModifiers& SymbolModifiers::operator|=(QCString mdfString) { mdfString = mdfString.lower(); @@ -2375,7 +2375,7 @@ static void subrHandleCommentBlock(const QCString &doc,bool brief) // strip direction loc_doc = loc_doc.right(loc_doc.length()-strlen(directionParam[SymbolModifiers::IN])); loc_doc.stripWhiteSpace(); - // in case of emty documentation or (now) just name, consider it as no documemntation + // in case of empty documentation or (now) just name, consider it as no documemntation if (loc_doc.isEmpty() || (loc_doc.lower() == argName.lower())) { // reset current back to the part inside the routine diff --git a/src/htmlentity.cpp b/src/htmlentity.cpp index 668c224..3d95705 100644 --- a/src/htmlentity.cpp +++ b/src/htmlentity.cpp @@ -22,7 +22,7 @@ static const int g_numberHtmlMappedCmds = 11; //! @brief Structure defining all HTML4 entities, doxygen extensions and doxygen commands representing special symbols. //! @details In case an entity does not exist a NULL is given for the entity. The first column contains the symbolic code -//! for the entity, see also doxparser.h The second column contains the name of the enitity (without the starting \& and +//! for the entity, see also doxparser.h The second column contains the name of the entity (without the starting \& and //! ending ;) static struct htmlEntityInfo { diff --git a/src/rtfgen.cpp b/src/rtfgen.cpp index 5e8dbd5..7fcfbb3 100644 --- a/src/rtfgen.cpp +++ b/src/rtfgen.cpp @@ -2448,7 +2448,7 @@ static bool preProcessFile(QDir &d,QCString &infName, FTextStream &t, bool bIncl } else // no INCLUDETEXT on this line { - // elaborate hoopla to skip the final "}" if we didn't include the + // elaborate hoopla to skip the final "}" if we didn't include the // headers if (!f.atEnd() || bIncludeHeader) { diff --git a/src/tclscanner.l b/src/tclscanner.l index e50d9c1..791ecc4 100644 --- a/src/tclscanner.l +++ b/src/tclscanner.l @@ -426,7 +426,7 @@ static struct QCString file_name; // name of used file ParserInterface *this_parser; // myself int command; // true if command was found - int comment; // set true if comment was scaned + int comment; // set true if comment was scanned int brace_level; // bookkeeping of braces int bracket_level; // bookkeeping of brackets int bracket_quote; // bookkeeping of quotes (toggles) diff --git a/src/template.cpp b/src/template.cpp index 10b3e43..3e39d3c 100644 --- a/src/template.cpp +++ b/src/template.cpp @@ -5113,7 +5113,7 @@ class TemplateEngine::Private } else { - err("Cound not open template file %s\n",fileName.data()); + err("Could not open template file %s\n",fileName.data()); } } return templ; diff --git a/src/util.cpp b/src/util.cpp index 8e4c5a7..438efc9 100644 --- a/src/util.cpp +++ b/src/util.cpp @@ -4751,7 +4751,7 @@ bool resolveRef(/* in */ const char *scName, { return resolveRef(scName,name,inSeeBlock,resContext,resMember,FALSE,0,checkScope); } - if (bracePos!=-1) // Try without parameters as well, could be a contructor invocation + if (bracePos!=-1) // Try without parameters as well, could be a constructor invocation { *resContext=getClass(fullName.left(bracePos)); if (*resContext) diff --git a/src/vhdlcode.l b/src/vhdlcode.l index 3e027d7..ce1f92b 100644 --- a/src/vhdlcode.l +++ b/src/vhdlcode.l @@ -13,7 +13,7 @@ * */ /****************************************************************************** - * Parser for syntax hightlighting and references for vhdl subset + * Parser for syntax highlighting and references for vhdl subset * written by M. Kreis * supports VHDL-87/93/2008 ******************************************************************************/ @@ -672,7 +672,7 @@ static void codifyMapLines(const char *text) }//codifymaplines /* -* writes a function|procedure prototype and links the function|procedure name +* writes a function|procedure prototype and links the function|procedure name */ static void writeFuncProto() @@ -710,7 +710,7 @@ static void writeFuncProto() } }// writeFuncProto -/* writes a process prototype to the ouput */ +/* writes a process prototype to the output */ static void writeProcessProto(){ codifyLines(g_FuncProto.data(),g_CurrClass.data()); @@ -1340,7 +1340,7 @@ XILINX "INST"|"NET"|"PIN"|"BLKNM"|"BUFG"|"COLLAPSE"|"CPLD"|"COMPGRP"|"CONFI writeFont("vhdlkeyword",vhdlcodeYYtext); } -<Bases>^{B}*("use"|"library"){BN}+ { //found package or library +<Bases>^{B}*("use"|"library"){BN}+ { //found package or library writeFont("vhdlkeyword",vhdlcodeYYtext); BEGIN(ParsePackage); } diff --git a/src/vhdldocgen.cpp b/src/vhdldocgen.cpp index 7883327..dcf7f42 100644 --- a/src/vhdldocgen.cpp +++ b/src/vhdldocgen.cpp @@ -174,7 +174,7 @@ static void createSVG() } } -// Creates a svg image. All in/out/inout ports are shown with brief description and direction. +// Creates an svg image. All in/out/inout ports are shown with brief description and direction. // Brief descriptions for entities are shown too. void VhdlDocGen::writeOverview() { @@ -585,7 +585,7 @@ const char* g_vhdlKeyWordMap0[] = "map","mod", "nand","new","next","nor","not","null", "of","on","open","or","others","out", - "package","parameter","port","postponed","procedure","process","property","proctected","pure", + "package","parameter","port","postponed","procedure","process","property","protected","pure", "range","record","register","reject","release","restrict","restrict_guarantee","rem","report","rol","ror","return", "select","sequence","severity","signal","shared","sla","sll","sra","srl","strong","subtype", "then","to","transport","type", @@ -2530,7 +2530,7 @@ QCString VhdlDocGen::trDesignUnitMembers() QCString VhdlDocGen::trDesignUnitListDescription() { return "Here is a list of all design unit members with links to " - "the Entities they belong to:"; + "the Entities they belong to:"; } QCString VhdlDocGen::trDesignUnitIndex() @@ -3039,7 +3039,7 @@ void assignBinding(VhdlConfNode * conf) /* // file foo.vhd -// enitity foo +// entity foo // ..... // end entity @@ -3993,7 +3993,7 @@ void FlowChart::createSVG() //const MemberDef *m=VhdlDocGen::getFlowMember(); //if (m) - // fprintf(stderr,"\n creating flowchart : %s %s in file %s \n",VhdlDocGen::trTypeString(m->getMemberSpecifiers()),m->name().data(),m->getFileDef()->name().data()); + // fprintf(stderr,"\n creating flowchart : %s %s in file %s \n",VhdlDocGen::trTypeString(m->getMemberSpecifiers()),m->name().data(),m->getFileDef()->name().data()); QCString dir=" -o \""+ov+qcs+"\""; ov+="/flow_design.dot"; diff --git a/src/xmlcode.l b/src/xmlcode.l index c090531..d2f94ad 100644 --- a/src/xmlcode.l +++ b/src/xmlcode.l @@ -13,7 +13,7 @@ * */ /****************************************************************************** - * Parser for syntax hightlighting and references for XML + * Parser for syntax highlighting and references for XML * written by Weston Thayer ******************************************************************************/ diff --git a/src/xmldocvisitor.cpp b/src/xmldocvisitor.cpp index 55c2b38..93765b1 100644 --- a/src/xmldocvisitor.cpp +++ b/src/xmldocvisitor.cpp @@ -770,17 +770,22 @@ void XmlDocVisitor::visitPre(DocImage *img) visitPreStart(m_t, "image", FALSE, this, img->children(), baseName, TRUE, img->type(), img->width(), img->height()); // copy the image to the output dir - QFile inImage(img->name()); - QFile outImage(Config_getString(XML_OUTPUT)+"/"+baseName.data()); - if (inImage.open(IO_ReadOnly)) + FileDef *fd; + bool ambig; + if ((fd=findFileDef(Doxygen::imageNameDict,img->name(),ambig))) { - if (outImage.open(IO_WriteOnly)) + QFile inImage(fd->absFilePath()); + QFile outImage(Config_getString(XML_OUTPUT)+"/"+baseName.data()); + if (inImage.open(IO_ReadOnly)) { - char *buffer = new char[inImage.size()]; - inImage.readBlock(buffer,inImage.size()); - outImage.writeBlock(buffer,inImage.size()); - outImage.flush(); - delete[] buffer; + if (outImage.open(IO_WriteOnly)) + { + char *buffer = new char[inImage.size()]; + inImage.readBlock(buffer,inImage.size()); + outImage.writeBlock(buffer,inImage.size()); + outImage.flush(); + delete[] buffer; + } } } } diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp index 1b03c3b..2222e46 100644 --- a/src/xmlgen.cpp +++ b/src/xmlgen.cpp @@ -136,7 +136,9 @@ inline void writeXMLCodeString(FTextStream &t,const char *s, int &col) case 11: case 12: case 13: case 14: case 15: case 16: case 17: case 18: case 19: case 20: case 21: case 22: case 23: case 24: case 25: case 26: case 27: case 28: case 29: case 30: case 31: - break; // skip invalid XML characters (see http://www.w3.org/TR/2000/REC-xml-20001006#NT-Char) + // encode invalid XML characters (see http://www.w3.org/TR/2000/REC-xml-20001006#NT-Char) + t << "<sp value=\"" << int(c) << "\"/>"; + break; default: s=writeUtf8Char(t,s-1); col++; break; } } @@ -668,6 +670,13 @@ static void generateXMLForMember(MemberDef *md,FTextStream &ti,FTextStream &t,De t << "\""; } + if (md->memberType() == MemberType_Enumeration) + { + t << " strong=\""; + if (md->isStrong()) t << "yes"; else t << "no"; + t << "\""; + } + if (md->memberType() == MemberType_Variable) { //ArgumentList *al = md->argumentList(); @@ -789,10 +798,7 @@ static void generateXMLForMember(MemberDef *md,FTextStream &ti,FTextStream &t,De md->memberType()!=MemberType_Enumeration ) { - if (md->memberType()!=MemberType_Typedef) - { - writeMemberTemplateLists(md,t); - } + writeMemberTemplateLists(md,t); QCString typeStr = md->typeString(); //replaceAnonymousScopes(md->typeString()); stripQualifiers(typeStr); t << " <type>"; @@ -802,6 +808,13 @@ static void generateXMLForMember(MemberDef *md,FTextStream &ti,FTextStream &t,De t << " <argsstring>" << convertToXML(md->argsString()) << "</argsstring>" << endl; } + if (md->memberType() == MemberType_Enumeration) + { + t << " <type>"; + linkifyText(TextGeneratorXMLImpl(t),def,md->getBodyDef(),md,md->enumBaseType()); + t << "</type>" << endl; + } + t << " <name>" << convertToXML(md->name()) << "</name>" << endl; if (md->memberType() == MemberType_Property) @@ -1825,6 +1838,13 @@ static void generateXMLForPage(PageDef *pd,FTextStream &ti,bool isExample) } } writeInnerPages(pd->getSubPages(),t); + if(pd->showToc()) + { + t << " <tableofcontents/>" << endl; + } + t << " <briefdescription>" << endl; + writeXMLDocBlock(t,pd->briefFile(),pd->briefLine(),pd,0,pd->briefDescription()); + t << " </briefdescription>" << endl; t << " <detaileddescription>" << endl; if (isExample) { diff --git a/templates/html/sync_off.luma b/templates/html/sync_off.luma index 6f7567c..b81fb87 100644 --- a/templates/html/sync_off.luma +++ b/templates/html/sync_off.luma @@ -1,4 +1,4 @@ -# synchonized view disabled button +# synchronized view disabled button # width & height 24 24 # luma data diff --git a/templates/html/sync_on.luma b/templates/html/sync_on.luma index ca79254..e89a9f3 100644 --- a/templates/html/sync_on.luma +++ b/templates/html/sync_on.luma @@ -1,4 +1,4 @@ -# synchonized view enabled button +# synchronized view enabled button # width & height 24 24 # luma data diff --git a/templates/xml/compound.xsd b/templates/xml/compound.xsd index 8affc20..b4356ac 100644 --- a/templates/xml/compound.xsd +++ b/templates/xml/compound.xsd @@ -29,6 +29,7 @@ <xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" /> <xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" /> + <xsd:element name="tableofcontents" minOccurs="0" maxOccurs="1" /> <xsd:element name="briefdescription" type="descriptionType" minOccurs="0" /> <xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" /> <xsd:element name="inheritancegraph" type="graphType" minOccurs="0" /> @@ -146,6 +147,7 @@ <xsd:attribute name="id" type="xsd:string" /> <xsd:attribute name="prot" type="DoxProtectionKind" /> <xsd:attribute name="static" type="DoxBool" /> + <xsd:attribute name="strong" type="DoxBool" use="optional"/> <xsd:attribute name="const" type="DoxBool" use="optional"/> <xsd:attribute name="explicit" type="DoxBool" use="optional"/> <xsd:attribute name="inline" type="DoxBool" use="optional"/> @@ -279,12 +281,16 @@ <xsd:complexType name="highlightType" mixed="true"> <xsd:choice minOccurs="0" maxOccurs="unbounded"> - <xsd:element name="sp" /> + <xsd:element name="sp" type="spType" /> <xsd:element name="ref" type="refTextType" /> </xsd:choice> <xsd:attribute name="class" type="DoxHighlightClass" /> </xsd:complexType> + <xsd:complexType name="spType" mixed="true"> + <xsd:attribute name="value" type="xsd:integer" use="optional"/> + </xsd:complexType> + <xsd:complexType name="referenceType" mixed="true"> <xsd:attribute name="refid" type="xsd:string" /> <xsd:attribute name="compoundref" type="xsd:string" use="optional" /> diff --git a/testing/001/indexpage.xml b/testing/001/indexpage.xml index 06d680b..0d567f5 100644 --- a/testing/001/indexpage.xml +++ b/testing/001/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Text <emphasis>argument</emphasis> more text. </para> </detaileddescription> diff --git a/testing/002/indexpage.xml b/testing/002/indexpage.xml index 1eba9d5..25a731b 100644 --- a/testing/002/indexpage.xml +++ b/testing/002/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <indexentry> diff --git a/testing/003/indexpage.xml b/testing/003/indexpage.xml index a4f42e2..dbd1559 100644 --- a/testing/003/indexpage.xml +++ b/testing/003/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para><ref refid="index_1myanchor" kindref="member">See Anchor</ref> Some text. <anchor id="index_1myanchor"/>More text. </para> </detaileddescription> diff --git a/testing/004/indexpage.xml b/testing/004/indexpage.xml index 3d0a713..fdaea0d 100644 --- a/testing/004/indexpage.xml +++ b/testing/004/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para><itemizedlist><listitem><para><computeroutput>AlignLeft</computeroutput> left alignment. </para></listitem><listitem><para><computeroutput>AlignCenter</computeroutput> center alignment. </para></listitem><listitem><para><computeroutput>AlignRight</computeroutput> right alignment</para></listitem></itemizedlist> No other types of alignment are supported.</para> diff --git a/testing/005/indexpage.xml b/testing/005/indexpage.xml index 5a2e6f9..4a12dfd 100644 --- a/testing/005/indexpage.xml +++ b/testing/005/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <simplesect kind="attention"> diff --git a/testing/006/indexpage.xml b/testing/006/indexpage.xml index 1afe69b..162aac0 100644 --- a/testing/006/indexpage.xml +++ b/testing/006/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <simplesect kind="author"> diff --git a/testing/007/indexpage.xml b/testing/007/indexpage.xml index 9b22813..8e85063 100644 --- a/testing/007/indexpage.xml +++ b/testing/007/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Text <bold>bold</bold> normal text. </para> </detaileddescription> diff --git a/testing/009/bug.xml b/testing/009/bug.xml index 1d80134..a6dfe88 100644 --- a/testing/009/bug.xml +++ b/testing/009/bug.xml @@ -3,6 +3,8 @@ <compounddef id="bug" kind="page"> <compoundname>bug</compoundname> <title>Bug List</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <variablelist> diff --git a/testing/009/deprecated.xml b/testing/009/deprecated.xml index 0613b25..5db2acd 100644 --- a/testing/009/deprecated.xml +++ b/testing/009/deprecated.xml @@ -3,6 +3,8 @@ <compounddef id="deprecated" kind="page"> <compoundname>deprecated</compoundname> <title>Deprecated List</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <variablelist> diff --git a/testing/009/reminders.xml b/testing/009/reminders.xml index e9983ed..a5c5560 100644 --- a/testing/009/reminders.xml +++ b/testing/009/reminders.xml @@ -3,6 +3,8 @@ <compounddef id="reminders" kind="page"> <compoundname>reminders</compoundname> <title>Reminders</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <variablelist> diff --git a/testing/009/test.xml b/testing/009/test.xml index 14395bf..e206440 100644 --- a/testing/009/test.xml +++ b/testing/009/test.xml @@ -3,6 +3,8 @@ <compounddef id="test" kind="page"> <compoundname>test</compoundname> <title>Test List</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <variablelist> diff --git a/testing/009/todo.xml b/testing/009/todo.xml index 4b731e3..88d050e 100644 --- a/testing/009/todo.xml +++ b/testing/009/todo.xml @@ -3,6 +3,8 @@ <compounddef id="todo" kind="page"> <compoundname>todo</compoundname> <title>Todo List</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <variablelist> diff --git a/testing/010/indexpage.xml b/testing/010/indexpage.xml index 61f515c..05c297e 100644 --- a/testing/010/indexpage.xml +++ b/testing/010/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Text <computeroutput>code</computeroutput> normal text.</para> <para>Text <computeroutput>code</computeroutput> normal text. </para> diff --git a/testing/012/citelist.xml b/testing/012/citelist.xml index 6b11c4f..96b94a3 100644 --- a/testing/012/citelist.xml +++ b/testing/012/citelist.xml @@ -3,6 +3,8 @@ <compounddef id="citelist" kind="page"> <compoundname>citelist</compoundname> <title>Bibliography</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <variablelist> diff --git a/testing/012/indexpage.xml b/testing/012/indexpage.xml index 926b53b..73fb669 100644 --- a/testing/012/indexpage.xml +++ b/testing/012/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>See <ref refid="citelist_1CITEREF_knuth79" kindref="member">[1]</ref> for more info. </para> </detaileddescription> diff --git a/testing/014/indexpage.xml b/testing/014/indexpage.xml index e677e24..7cbc82f 100644 --- a/testing/014/indexpage.xml +++ b/testing/014/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <programlisting filename=".py"> diff --git a/testing/017/indexpage.xml b/testing/017/indexpage.xml index f1bfc5e..3326ee8 100644 --- a/testing/017/indexpage.xml +++ b/testing/017/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <simplesect kind="copyright"> diff --git a/testing/018/018__def_8c.xml b/testing/018/018__def_8c.xml index 8518666..5f42767 100644 --- a/testing/018/018__def_8c.xml +++ b/testing/018/018__def_8c.xml @@ -17,7 +17,8 @@ </memberdef> </sectiondef> <sectiondef kind="enum"> - <memberdef kind="enum" id="018__def_8c_1aa57b8491d1d8fc1014dd54bcf83b130a" prot="public" static="no"> + <memberdef kind="enum" id="018__def_8c_1aa57b8491d1d8fc1014dd54bcf83b130a" prot="public" static="no" strong="no"> + <type/> <name>E</name> <enumvalue id="018__def_8c_1aa57b8491d1d8fc1014dd54bcf83b130aab1710e6a49014ba389d57c8753c530f4" prot="public"> <name>E1</name> diff --git a/testing/020/indexpage.xml b/testing/020/indexpage.xml index f7cd444..3171e13 100644 --- a/testing/020/indexpage.xml +++ b/testing/020/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Text. XML diff --git a/testing/021/indexpage.xml b/testing/021/indexpage.xml index 9205dd6..7c93a78 100644 --- a/testing/021/indexpage.xml +++ b/testing/021/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> Our main function starts like this: <programlisting filename="example_test.cpp"><codeline><highlight class="normal">void<sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline></programlisting> First we create a object <computeroutput>t</computeroutput> of the <ref refid="class_test" kindref="compound">Test</ref> class. <programlisting filename="example_test.cpp"><codeline><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline></programlisting> Then we call the example member function <programlisting filename="example_test.cpp"><codeline><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline></programlisting> After that our little test routine ends. <programlisting filename="example_test.cpp"><codeline><highlight class="normal">}</highlight></codeline></programlisting> </para> </detaileddescription> diff --git a/testing/022/indexpage.xml b/testing/022/indexpage.xml index afcf23a..0fcee9c 100644 --- a/testing/022/indexpage.xml +++ b/testing/022/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Class relations expressed via an inline dot graph: <dot> digraph example { diff --git a/testing/023/indexpage.xml b/testing/023/indexpage.xml index b907db9..c87860c 100644 --- a/testing/023/indexpage.xml +++ b/testing/023/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Normal <emphasis>emphasis</emphasis> and more <emphasis>emphasis</emphasis> back to normal. </para> </detaileddescription> diff --git a/testing/024/indexpage.xml b/testing/024/indexpage.xml index 11a385b..7396177 100644 --- a/testing/024/indexpage.xml +++ b/testing/024/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Unconditional (start) Enabled (if). Enabled (else). Unconditional (middle) Enabled (else). Unconditional (end) </para> </detaileddescription> diff --git a/testing/025/example_test_8cpp-example.xml b/testing/025/example_test_8cpp-example.xml index 96a1cd7..6bcee68 100644 --- a/testing/025/example_test_8cpp-example.xml +++ b/testing/025/example_test_8cpp-example.xml @@ -2,9 +2,11 @@ <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version=""> <compounddef id="example_test_8cpp-example" kind="example"> <compoundname>example_test.cpp</compoundname> + <briefdescription> + </briefdescription> <detaileddescription> <para>This is an example of how to use the <ref refid="class_test" kindref="compound">Test</ref> class.</para> - <para>More details about this example. <programlisting filename="example_test.cpp"><codeline><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><ref refid="class_test" kindref="compound">Test</ref><sp/>t;</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>t.<ref refid="class_test_1a47b775f65718978f1ffcd96376f8ecfa" kindref="member">example</ref>();</highlight></codeline><codeline><highlight class="normal">}</highlight></codeline><codeline><highlight class="normal"/></codeline></programlisting> </para> + <para>More details about this example. <programlisting filename="example_test.cpp"><codeline><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal">*<sp/>a<sp/>=<sp/></highlight><highlight class="stringliteral">"Some<sp/>special<sp/>character<sp/>here:<sp/><sp value="7"/><sp/>"</highlight><highlight class="normal">;</highlight></codeline><codeline><highlight class="normal"/></codeline><codeline><highlight class="normal"><sp/><sp/><ref refid="class_test" kindref="compound">Test</ref><sp/>t;</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>t.<ref refid="class_test_1a47b775f65718978f1ffcd96376f8ecfa" kindref="member">example</ref>();</highlight></codeline><codeline><highlight class="normal">}</highlight></codeline><codeline><highlight class="normal"/></codeline></programlisting> </para> </detaileddescription> </compounddef> </doxygen> diff --git a/testing/028/indexpage.xml b/testing/028/indexpage.xml index d508adb..c13e1b2 100644 --- a/testing/028/indexpage.xml +++ b/testing/028/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Here are some formulas:<orderedlist><listitem><para>The distance between <formula id="0">$(x_1,y_1)$</formula> and <formula id="1">$(x_2,y_2)$</formula> is <formula id="2">$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}$</formula>.</para></listitem><listitem><para>Unnumbered formula: <formula id="3">\[ |I_2|=\left| \int_{0}^T \psi(t) \left\{ u(a,t)- \int_{\gamma(t)}^a \frac{d\theta}{k(\theta,t)} \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi \right\} dt \right| \]</formula></para></listitem><listitem><para>Formula in different environment <formula id="4">\begin{eqnarray*} g &=& \frac{Gm_2}{r^2} \\ &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\, \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ &=& 9.82066032\,\mbox{m/s}^2 \end{eqnarray*}</formula> </para></listitem></orderedlist> </para> diff --git a/testing/030/indexpage.xml b/testing/030/indexpage.xml index 62046d4..6731890 100644 --- a/testing/030/indexpage.xml +++ b/testing/030/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Some text. <htmlonly><h1>Hello world</h1> </htmlonly> More text. </para> diff --git a/testing/031/indexpage.xml b/testing/031/indexpage.xml index a0297fa..3b3a2e3 100644 --- a/testing/031/indexpage.xml +++ b/testing/031/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Some text. <image type="html" name="sample.png"/> <image type="latex" name="sample.png" width="5cm">Doxygen logo</image> diff --git a/testing/032/indexpage.xml b/testing/032/indexpage.xml index 3a25272..89d8c1f 100644 --- a/testing/032/indexpage.xml +++ b/testing/032/indexpage.xml @@ -3,8 +3,10 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> - <para>Some text. <programlisting filename="example_test.cpp"><codeline><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline><codeline><highlight class="normal">}</highlight></codeline><codeline><highlight class="normal"/></codeline></programlisting> More text. <programlisting filename="example_test.cpp"><codeline lineno="1"><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline lineno="2"><highlight class="normal">{</highlight></codeline><codeline lineno="3"><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline><codeline lineno="4"><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline><codeline lineno="5"><highlight class="normal">}</highlight></codeline><codeline lineno="6"><highlight class="normal"/></codeline></programlisting> End. </para> + <para>Some text. <programlisting filename="example_test.cpp"><codeline><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal">*<sp/>a<sp/>=<sp/></highlight><highlight class="stringliteral">"Some<sp/>special<sp/>character<sp/>here:<sp/><sp value="7"/><sp/>"</highlight><highlight class="normal">;</highlight></codeline><codeline><highlight class="normal"/></codeline><codeline><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline><codeline><highlight class="normal">}</highlight></codeline><codeline><highlight class="normal"/></codeline></programlisting> More text. <programlisting filename="example_test.cpp"><codeline lineno="1"><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline lineno="2"><highlight class="normal">{</highlight></codeline><codeline lineno="3"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal">*<sp/>a<sp/>=<sp/></highlight><highlight class="stringliteral">"Some<sp/>special<sp/>character<sp/>here:<sp/><sp value="7"/><sp/>"</highlight><highlight class="normal">;</highlight></codeline><codeline lineno="4"><highlight class="normal"/></codeline><codeline lineno="5"><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline><codeline lineno="6"><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline><codeline lineno="7"><highlight class="normal">}</highlight></codeline><codeline lineno="8"><highlight class="normal"/></codeline></programlisting> End. </para> </detaileddescription> </compounddef> </doxygen> diff --git a/testing/033/indexpage.xml b/testing/033/indexpage.xml index 4b2f47d..652e5de 100644 --- a/testing/033/indexpage.xml +++ b/testing/033/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Some text.</para> <para>More visible text. </para> diff --git a/testing/034/indexpage.xml b/testing/034/indexpage.xml index e994666..0252b3c 100644 --- a/testing/034/indexpage.xml +++ b/testing/034/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Some text. </para> <internal> diff --git a/testing/038/indexpage.xml b/testing/038/indexpage.xml index 3657034..2258113 100644 --- a/testing/038/indexpage.xml +++ b/testing/038/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Text<linebreak/> New line<linebreak/> diff --git a/testing/043/another.xml b/testing/043/another.xml index f403e8f..2c2e61b 100644 --- a/testing/043/another.xml +++ b/testing/043/another.xml @@ -3,6 +3,8 @@ <compounddef id="another" kind="page"> <compoundname>another</compoundname> <title>Another Page</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Another page's text. </para> </detaileddescription> diff --git a/testing/043/mypage.xml b/testing/043/mypage.xml index efb09c7..79fb7ae 100644 --- a/testing/043/mypage.xml +++ b/testing/043/mypage.xml @@ -4,7 +4,12 @@ <compoundname>mypage</compoundname> <title>Page Title</title> <innerpage refid="another">Another Page</innerpage> + <tableofcontents/> + <briefdescription> + <para>Page brief description. </para> + </briefdescription> <detaileddescription> + <para>Page brief description.</para> <para>Text at page level. See <ref refid="mypage_1mysect" kindref="member">Section Title.</ref> for more. </para> <sect1 id="mypage_1mysect"> <title>Section Title.</title> diff --git a/testing/043_page.dox b/testing/043_page.dox index 784f58d..38c1894 100644 --- a/testing/043_page.dox +++ b/testing/043_page.dox @@ -2,6 +2,10 @@ // check: mypage.xml // check: another.xml /** \page mypage Page Title + * \brief Page brief description. + * + * @tableofcontents + * * Text at page level. See \ref mysect for more. * \section mysect Section Title. * Text at section level. See \ref mysubsect for more. diff --git a/testing/045/indexpage.xml b/testing/045/indexpage.xml index 75de4ab..294ceb8 100644 --- a/testing/045/indexpage.xml +++ b/testing/045/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <toclist> diff --git a/testing/049/indexpage.xml b/testing/049/indexpage.xml index 461a174..f7cb48c 100644 --- a/testing/049/indexpage.xml +++ b/testing/049/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>A bubble sort algorithm First get the inputs <programlisting filename="snippet_test.cpp"><codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal">(i=0<sp/>;<sp/>i<n<sp/>;<sp/>i++)</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/>printf(</highlight><highlight class="stringliteral">"<sp/>Array[%d]<sp/>=<sp/>"</highlight><highlight class="normal">,i);</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/>scanf(</highlight><highlight class="stringliteral">"%d"</highlight><highlight class="normal">,&arr[i]);</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>}</highlight></codeline></programlisting>Then do the bubbling <programlisting filename="snippet_test.cpp"><codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal">(i=0<sp/>;<sp/>i<n<sp/>;<sp/>i++)</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal">(j=0<sp/>;<sp/>j<n-i-1<sp/>;<sp/>j++)</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal">(arr[j]>arr[j+1])<sp/></highlight><highlight class="comment">//Swapping<sp/>Condition<sp/>is<sp/>Checked</highlight><highlight class="normal"/></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>temp=arr[j];</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>arr[j]=arr[j+1];</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>arr[j+1]=temp;</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>}</highlight></codeline></programlisting>Then write the result <programlisting filename="snippet_test.cpp"><codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal">(i=0<sp/>;<sp/>i<n<sp/>;<sp/>i++)</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/><sp/><sp/>printf(</highlight><highlight class="stringliteral">"<sp/>%4d"</highlight><highlight class="normal">,arr[i]);</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>}</highlight></codeline></programlisting></para> </detaileddescription> diff --git a/testing/050/indexpage.xml b/testing/050/indexpage.xml index 73b6d4f..2f183fe 100644 --- a/testing/050/indexpage.xml +++ b/testing/050/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Some normal text. <verbatim>A verbatim section with a /* C comment */ in it </verbatim> Showing a file as verbatim <verbatim>@book{knuth79, diff --git a/testing/051/indexpage.xml b/testing/051/indexpage.xml index 82c58cc..776f525 100644 --- a/testing/051/indexpage.xml +++ b/testing/051/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Dollar $ At @ Backslash \ Amphasand & Less < Greater > Hash # Percent % Quote " Dot . Double colon :: Pipe | Plus + Minus - </para> </detaileddescription> diff --git a/testing/052/indexpage.xml b/testing/052/indexpage.xml index 792bee4..d952781 100644 --- a/testing/052/indexpage.xml +++ b/testing/052/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>This is English. Output for all languages. </para> </detaileddescription> diff --git a/testing/053/indexpage.xml b/testing/053/indexpage.xml index 828fe96..211bb9a 100644 --- a/testing/053/indexpage.xml +++ b/testing/053/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Dit is Nederlands. Output for all languages. </para> </detaileddescription> diff --git a/testing/055/md_055_markdown.xml b/testing/055/md_055_markdown.xml index 18df45b..4bdd2e2 100644 --- a/testing/055/md_055_markdown.xml +++ b/testing/055/md_055_markdown.xml @@ -3,6 +3,8 @@ <compounddef id="md_055_markdown" kind="page"> <compoundname>md_055_markdown</compoundname> <title>055_markdown</title> + <briefdescription> + </briefdescription> <detaileddescription> <para> <heading level="1">Foo</heading> diff --git a/testing/056/indexpage.xml b/testing/056/indexpage.xml index 8376a74..55240e9 100644 --- a/testing/056/indexpage.xml +++ b/testing/056/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>Some text. <latexonly>\section{Hello world} </latexonly> More text. </para> diff --git a/testing/065/indexpage.xml b/testing/065/indexpage.xml index e462e55..09c7f8c 100644 --- a/testing/065/indexpage.xml +++ b/testing/065/indexpage.xml @@ -3,6 +3,8 @@ <compounddef id="indexpage" kind="page"> <compoundname>index</compoundname> <title>My Project</title> + <briefdescription> + </briefdescription> <detaileddescription> <para>これは日本語(en)です. Output for all languages. </para> </detaileddescription> diff --git a/testing/067/067__using_8cpp.xml b/testing/067/067__using_8cpp.xml new file mode 100644 index 0000000..c278161 --- /dev/null +++ b/testing/067/067__using_8cpp.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version=""> + <compounddef id="067__using_8cpp" kind="file" language="C++"> + <compoundname>067_using.cpp</compoundname> + <sectiondef kind="typedef"> + <memberdef kind="typedef" id="067__using_8cpp_1a1b01c504448c96cd2191a5184dd31acf" prot="public" static="no"> + <templateparamlist> + <param> + <type>class T</type> + </param> + </templateparamlist> + <type>std::vector< T ></type> + <definition>using Vec = std::vector<T></definition> + <argsstring/> + <name>Vec</name> + <briefdescription> + <para>A vector. </para> + </briefdescription> + <detaileddescription> + </detaileddescription> + <inbodydescription> + </inbodydescription> + <location file="067_using.cpp" line="7" column="1" bodyfile="067_using.cpp" bodystart="7" bodyend="-1"/> + </memberdef> + </sectiondef> + <briefdescription> + </briefdescription> + <detaileddescription> + </detaileddescription> + <location file="067_using.cpp"/> + </compounddef> +</doxygen> diff --git a/testing/067_using.cpp b/testing/067_using.cpp new file mode 100644 index 0000000..eb2f5cc --- /dev/null +++ b/testing/067_using.cpp @@ -0,0 +1,7 @@ +// objective: test template parameters for a type alias +// check: 067__using_8cpp.xml + +/** \file */ + +/** @brief A vector */ +template<class T> using Vec = std::vector<T>; diff --git a/testing/068/068__typed__enum_8cpp.xml b/testing/068/068__typed__enum_8cpp.xml new file mode 100644 index 0000000..880bf14 --- /dev/null +++ b/testing/068/068__typed__enum_8cpp.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version=""> + <compounddef id="068__typed__enum_8cpp" kind="file" language="C++"> + <compoundname>068_typed_enum.cpp</compoundname> + <sectiondef kind="enum"> + <memberdef kind="enum" id="068__typed__enum_8cpp_1aa72902e6181db009a6a84502f81612c2" prot="public" static="no" strong="yes"> + <type>unsigned short</type> + <name>E</name> + <briefdescription> + <para>A strongly-typed enum. </para> + </briefdescription> + <detaileddescription> + </detaileddescription> + <inbodydescription> + </inbodydescription> + <location file="068_typed_enum.cpp" line="7" column="1" bodyfile="068_typed_enum.cpp" bodystart="7" bodyend="7"/> + </memberdef> + </sectiondef> + <briefdescription> + </briefdescription> + <detaileddescription> + </detaileddescription> + <location file="068_typed_enum.cpp"/> + </compounddef> +</doxygen> diff --git a/testing/068_typed_enum.cpp b/testing/068_typed_enum.cpp new file mode 100644 index 0000000..44c4123 --- /dev/null +++ b/testing/068_typed_enum.cpp @@ -0,0 +1,7 @@ +// objective: test underlying type and strongness for an enum +// check: 068__typed__enum_8cpp.xml + +/** \file */ + +/** @brief A strongly-typed enum */ +enum class E: unsigned short {}; diff --git a/testing/example_test.cpp b/testing/example_test.cpp index f589023..a117b63 100644 --- a/testing/example_test.cpp +++ b/testing/example_test.cpp @@ -1,5 +1,7 @@ void main() { + const char* a = "Some special character here: "; + Test t; t.example(); } |