From e366acaf0c27ce43ec80a70c0667c27cd5ef9d29 Mon Sep 17 00:00:00 2001 From: albert-github Date: Wed, 11 Mar 2015 18:07:02 +0100 Subject: Internal doxygen docs gives: warning: Unsupported xml/html tag <...> found When generating the doxygen internal documentation we get the warning about Unsupported xml/html tag. This patch fixes this problem. (TokenManager.h is said to be generated code but original source is not found). --- src/arguments.h | 2 +- vhdlparser/TokenManager.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/arguments.h b/src/arguments.h index 778fc32..8b3d211 100644 --- a/src/arguments.h +++ b/src/arguments.h @@ -70,7 +70,7 @@ struct Argument QCString array; /*!< Argument's array specifier (may be empty) */ QCString defval; /*!< Argument's default value (may be empty) */ QCString docs; /*!< Argument's documentation (may be empty) */ - QCString typeConstraint; /*!< Used for Java generics: */ + QCString typeConstraint; /*!< Used for Java generics: \ */ }; /*! \brief This class represents an function or template argument list. diff --git a/vhdlparser/TokenManager.h b/vhdlparser/TokenManager.h index 775e43d..68fbe2f 100644 --- a/vhdlparser/TokenManager.h +++ b/vhdlparser/TokenManager.h @@ -16,7 +16,7 @@ namespace parser { class TokenManager { public: /** This gets the next token from the input stream. - * A token of kind 0 () should be returned on EOF. + * A token of kind 0 (\) should be returned on EOF. */ virtual ~TokenManager() { } virtual Token *getNextToken() = 0; -- cgit v0.12 From 320ebb35dd4a615a7a692d71de4587be9ce8b99b Mon Sep 17 00:00:00 2001 From: albert-github Date: Wed, 11 Mar 2015 19:02:51 +0100 Subject: Showing grey/gray in documentation The US-English spelling is gray where as the British-English spelling is grey. The doxygen documentation is in US-English spelling. This patch corrects the wrong spelled, user visible, grey to gray. --- qtools/qfeatures.h | 2 +- src/translator_ar.h | 2 +- src/translator_en.h | 2 +- src/translator_fa.h | 2 +- src/translator_lt.h | 2 +- src/translator_lv.h | 2 +- src/translator_si.h | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/qtools/qfeatures.h b/qtools/qfeatures.h index d6c2882..1042ce6 100644 --- a/qtools/qfeatures.h +++ b/qtools/qfeatures.h @@ -378,7 +378,7 @@ */ //#define QT_NO_QWS_DEPTH_1 /*! - 4-bit greyscale + 4-bit grayscale */ //#define QT_NO_QWS_DEPTH_4 /*! diff --git a/src/translator_ar.h b/src/translator_ar.h index f23d6df..5daaa4c 100644 --- a/src/translator_ar.h +++ b/src/translator_ar.h @@ -1051,7 +1051,7 @@ class TranslatorArabic : public TranslatorAdapter_1_4_6 "
  • %A filled black box represents the struct or class for which the " "graph is generated.\n" "
  • %A box with a black border denotes a documented struct or class.\n" - "
  • %A box with a grey border denotes an undocumented struct or class.\n" + "
  • %A box with a gray border denotes an undocumented struct or class.\n" "
  • %A box with a red border denotes a documented struct or class for" "which not all inheritance/containment relations are shown. %A graph is " "truncated if it does not fit within the specified boundaries.\n" diff --git a/src/translator_en.h b/src/translator_en.h index 93998d2..ba89726 100644 --- a/src/translator_en.h +++ b/src/translator_en.h @@ -1022,7 +1022,7 @@ class TranslatorEnglish : public Translator "
  • %A filled gray box represents the struct or class for which the " "graph is generated.
    • \n" "
  • %A box with a black border denotes a documented struct or class.
    • \n" - "
  • %A box with a grey border denotes an undocumented struct or class.
    • \n" + "
  • %A box with a gray border denotes an undocumented struct or class.
    • \n" "
  • %A box with a red border denotes a documented struct or class for" "which not all inheritance/containment relations are shown. %A graph is " "truncated if it does not fit within the specified boundaries.
    • \n" diff --git a/src/translator_fa.h b/src/translator_fa.h index e18e118..7effafe 100644 --- a/src/translator_fa.h +++ b/src/translator_fa.h @@ -1022,7 +1022,7 @@ class TranslatorPersian : public TranslatorAdapter_1_7_5 "
  • %A filled black box represents the struct or class for which the " "graph is generated.\n" "
  • %A box with a black border denotes a documented struct or class.\n" - "
  • %A box with a grey border denotes an undocumented struct or class.\n" + "
  • %A box with a gray border denotes an undocumented struct or class.\n" "
  • %A box with a red border denotes a documented struct or class for" "which not all inheritance/containment relations are shown. %A graph is " "truncated if it does not fit within the specified boundaries.\n" diff --git a/src/translator_lt.h b/src/translator_lt.h index f6e07bf..faf4197 100644 --- a/src/translator_lt.h +++ b/src/translator_lt.h @@ -1013,7 +1013,7 @@ class TranslatorLithuanian : public TranslatorAdapter_1_4_6 "
  • %A filled black box represents the struct or class for which the " "graph is generated.\n" "
  • %A box with a black border denotes a documented struct or class.\n" - "
  • %A box with a grey border denotes an undocumented struct or class.\n" + "
  • %A box with a gray border denotes an undocumented struct or class.\n" "
  • %A box with a red border denotes a documented struct or class for" "which not all inheritance/containment relations are shown. %A graph is " "truncated if it does not fit within the specified boundaries.\n" diff --git a/src/translator_lv.h b/src/translator_lv.h index 1161d48..20b2a38 100644 --- a/src/translator_lv.h +++ b/src/translator_lv.h @@ -1028,7 +1028,7 @@ class TranslatorLatvian : public TranslatorAdapter_1_8_4 "
  • %A filled gray box represents the struct or class for which the " "graph is generated.
    • \n" "
  • %A box with a black border denotes a documented struct or class.
    • \n" - "
  • %A box with a grey border denotes an undocumented struct or class.
    • \n" + "
  • %A box with a gray border denotes an undocumented struct or class.
    • \n" "
  • %A box with a red border denotes a documented struct or class for" "which not all inheritance/containment relations are shown. %A graph is " "truncated if it does not fit within the specified boundaries.
    • \n" diff --git a/src/translator_si.h b/src/translator_si.h index 10193a6..97a1931 100644 --- a/src/translator_si.h +++ b/src/translator_si.h @@ -691,7 +691,7 @@ class TranslatorSlovene : public TranslatorAdapter_1_4_6 "
  • %A filled black box represents the struct or class for which the " "graph is generated.\n" "
  • %A box with a black border denotes a documented struct or class.\n" - "
  • %A box with a grey border denotes an undocumented struct or class.\n" + "
  • %A box with a gray border denotes an undocumented struct or class.\n" "
  • %A box with a red border denotes a documented struct or class for\n" "which not all inheritance/containment relations are shown. %A graph is " "truncated if it does not fit within the specified boundaries." -- cgit v0.12 From c9465bd210d8250a5439f22bf564c187cd45e968 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 15 Mar 2015 09:38:10 +0100 Subject: Fixed type in printdocvisitor.h --- src/printdocvisitor.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/printdocvisitor.h b/src/printdocvisitor.h index 874497f..95e7e47 100644 --- a/src/printdocvisitor.h +++ b/src/printdocvisitor.h @@ -189,7 +189,7 @@ class PrintDocVisitor : public DocVisitor void visit(DocFormula *f) { indent_leaf(); - printf("",f->name().data(),f->text().data()); + printf("",f->name().data(),f->text().data()); } void visit(DocIndexEntry *i) { -- cgit v0.12 From 95375152974fa7e0e4d4cec7007d942dd5e9615e Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 15 Mar 2015 13:17:14 +0100 Subject: Fixes for showing type constraint relations --- src/classdef.cpp | 3 ++- src/xmlgen.cpp | 6 ++++++ templates/xml/compound.xsd | 1 + 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/classdef.cpp b/src/classdef.cpp index ea6eece..d48efd0 100644 --- a/src/classdef.cpp +++ b/src/classdef.cpp @@ -2532,9 +2532,10 @@ bool ClassDef::hasExamples() const void ClassDef::addTypeConstraint(const QCString &typeConstraint,const QCString &type) { + //printf("addTypeContraint(%s,%s)\n",type.data(),typeConstraint.data()); static bool hideUndocRelation = Config_getBool("HIDE_UNDOC_RELATIONS"); if (typeConstraint.isEmpty() || type.isEmpty()) return; - ClassDef *cd = getClass(typeConstraint); + ClassDef *cd = getResolvedClass(this,getFileDef(),typeConstraint); if (cd==0 && !hideUndocRelation) { cd = new ClassDef(getDefFileName(),getDefLine(),getDefColumn(),typeConstraint,ClassDef::Class); diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp index c2eddd5..215b88a 100644 --- a/src/xmlgen.cpp +++ b/src/xmlgen.cpp @@ -394,6 +394,12 @@ static void writeTemplateArgumentList(ArgumentList *al, linkifyText(TextGeneratorXMLImpl(t),scope,fileScope,0,a->defval); t << "" << endl; } + if (!a->typeConstraint.isEmpty()) + { + t << indentStr << " "; + linkifyText(TextGeneratorXMLImpl(t),scope,fileScope,0,a->typeConstraint); + t << "" << endl; + } t << indentStr << " " << endl; } t << indentStr << "" << endl; diff --git a/templates/xml/compound.xsd b/templates/xml/compound.xsd index ff516e3..c960c7b 100644 --- a/templates/xml/compound.xsd +++ b/templates/xml/compound.xsd @@ -220,6 +220,7 @@ + -- cgit v0.12 From 072383ed1c6fcfff7a7619d92ce3a8cb0b91fff9 Mon Sep 17 00:00:00 2001 From: albert-github Date: Sun, 15 Mar 2015 18:11:58 +0100 Subject: HTML entity ° gives problems in LaTeX When having °C in the documentation there is no separation between the \textdegree and C in LaTeX. This patch fixes this problem. --- src/htmlentity.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/htmlentity.cpp b/src/htmlentity.cpp index 7b61ead..c4c601f 100644 --- a/src/htmlentity.cpp +++ b/src/htmlentity.cpp @@ -59,7 +59,7 @@ static struct htmlEntityInfo { SYM(shy), "\xc2\xad", "­", "", "­", "{$\\-$}", NULL, "\\-", { NULL, DocSymbol::Perl_unknown }}, { SYM(reg), "\xc2\xae", "®", "", "®", "\\textregistered{}", "(R)", "\\'AE", { "registered", DocSymbol::Perl_symbol }}, { SYM(macr), "\xc2\xaf", "¯", "", "¯", "\\={}", NULL, "\\'AF", { NULL, DocSymbol::Perl_unknown }}, - { SYM(deg), "\xc2\xb0", "°", "", "°", "\\textdegree", NULL, "\\'B0", { "deg", DocSymbol::Perl_symbol }}, + { SYM(deg), "\xc2\xb0", "°", "", "°", "\\textdegree{}", NULL, "\\'B0", { "deg", DocSymbol::Perl_symbol }}, { SYM(plusmn), "\xc2\xb1", "±", "", "±", "{$\\pm$}", NULL, "\\'B1", { "+/-", DocSymbol::Perl_string }}, { SYM(sup2), "\xc2\xb2", "²", "", "²", "\\texttwosuperior{}", NULL, "\\'B2", { NULL, DocSymbol::Perl_unknown }}, { SYM(sup3), "\xc2\xb3", "³", "", "³", "\\textthreesuperior{}", NULL, "\\'B3", { NULL, DocSymbol::Perl_unknown }}, -- cgit v0.12 From ebe3e8ec4a09edbb8a5b2dde88b6c479b03c0be9 Mon Sep 17 00:00:00 2001 From: albert-github Date: Sun, 15 Mar 2015 18:44:07 +0100 Subject: Internal debug option -d lex is not described The Internal debug option -d lex had not been described. --- src/doxygen.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/doxygen.md b/src/doxygen.md index 9a9d726..4caa198 100644 --- a/src/doxygen.md +++ b/src/doxygen.md @@ -168,6 +168,10 @@ easy ways to get debug information. command is specified) - validate
    Currently not used + - lex
    + Provide output of the `lex` files used. When a lexer ais started and when a lexer + ends the name of `lex` file is given so it is possible to see in which lexer the + problem occurs. This makes it easier to select the file to be compiled in `lex` debug mode. Producing output ---------------- -- cgit v0.12 From 00a91ae9fabe7783260c7c3fcdfec5b1ead49350 Mon Sep 17 00:00:00 2001 From: albert-github Date: Mon, 16 Mar 2015 20:03:16 +0100 Subject: Internal debug option -d lex is not described Corrected typing error in internal -d lex documentation --- src/doxygen.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/doxygen.md b/src/doxygen.md index 4caa198..ccb47b9 100644 --- a/src/doxygen.md +++ b/src/doxygen.md @@ -169,8 +169,8 @@ easy ways to get debug information. - validate
    Currently not used - lex
    - Provide output of the `lex` files used. When a lexer ais started and when a lexer - ends the name of `lex` file is given so it is possible to see in which lexer the + Provide output of the `lex` files used. When a lexer is started and when a lexer + ends the name of the `lex` file is given so it is possible to see in which lexer the problem occurs. This makes it easier to select the file to be compiled in `lex` debug mode. Producing output -- cgit v0.12