diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2020-08-10 18:58:42 (GMT) |
---|---|---|
committer | Dimitri van Heesch <doxygen@gmail.com> | 2020-08-10 18:58:42 (GMT) |
commit | 047adfbbc66eaa432ec9cea00e3801e3b4e1bca8 (patch) | |
tree | 968465194e062086a0432809c73fa9d89147ccbc /src | |
parent | 40d87c40019d55adf47e1e8ccf766a9d47eb1f79 (diff) | |
parent | e86cbe4f87d2fd8f8291322f9e271e961e1b7b47 (diff) | |
download | Doxygen-047adfbbc66eaa432ec9cea00e3801e3b4e1bca8.zip Doxygen-047adfbbc66eaa432ec9cea00e3801e3b4e1bca8.tar.gz Doxygen-047adfbbc66eaa432ec9cea00e3801e3b4e1bca8.tar.bz2 |
Merge branch 'master' of github.com:doxygen/doxygen
Diffstat (limited to 'src')
-rw-r--r-- | src/cite.cpp | 2 | ||||
-rw-r--r-- | src/config.xml | 10 | ||||
-rw-r--r-- | src/context.cpp | 2 | ||||
-rw-r--r-- | src/markdown.cpp | 2 | ||||
-rw-r--r-- | src/pyscanner.l | 4 |
5 files changed, 15 insertions, 5 deletions
diff --git a/src/cite.cpp b/src/cite.cpp index fd6fe3e..03bdb02 100644 --- a/src/cite.cpp +++ b/src/cite.cpp @@ -211,7 +211,7 @@ void CitationManager::insertCrossReferencesForBibFile(const QCString &bibFile) { QCString crossrefName = line.mid((uint)(j+1),(uint)(k-j-1)); // check if the reference with the cross reference is used - // insert cross refererence when cross reference has not yet been added. + // insert cross reference when cross reference has not yet been added. if ((p->entries.find(citeName.data())!=p->entries.end()) && (p->entries.find(crossrefName.data())==p->entries.end())) // not found yet { diff --git a/src/config.xml b/src/config.xml index 29f4068..b3718be 100644 --- a/src/config.xml +++ b/src/config.xml @@ -513,6 +513,16 @@ Go to the <a href="commands.html">next</a> section or return to the ]]> </docs> </option> + <option type='bool' id='PYTHON_DOCSTRING' defval='1'> + <docs> +<![CDATA[ + By default Python docstrings are displayed as preformatted text + and doxygen's special commands cannot be used. By setting \c PYTHON_DOCSTRING to + \c NO the doxygen's special commands can be used and the contents of the docstring + documentation blocks is shown as doxygen documentation. +]]> + </docs> + </option> <option type='bool' id='INHERIT_DOCS' defval='1'> <docs> <![CDATA[ diff --git a/src/context.cpp b/src/context.cpp index 3bdead3..2af2c84 100644 --- a/src/context.cpp +++ b/src/context.cpp @@ -1071,7 +1071,7 @@ class TranslateContext::Private s_inst.addProperty("namespaceList", &Private::namespaceList); //%% string namespaceMembers s_inst.addProperty("namespaceMembers", &Private::namespaceMembers); - //%% srting fileList + //%% string fileList s_inst.addProperty("fileList", &Private::fileList); //%% string fileMembers s_inst.addProperty("fileMembers", &Private::fileMembers); diff --git a/src/markdown.cpp b/src/markdown.cpp index 78e6a85..00c0723 100644 --- a/src/markdown.cpp +++ b/src/markdown.cpp @@ -194,7 +194,7 @@ Markdown::Markdown(const char *fileName,int lineNr,int indentLevel) enum Alignment { AlignNone, AlignLeft, AlignCenter, AlignRight }; -//---------- contants ------- +//---------- constants ------- // const uchar g_utf8_nbsp[3] = { 0xc2, 0xa0, 0}; // UTF-8 nbsp const char *g_doxy_nsbp = "&_doxy_nbsp;"; // doxygen escape command for UTF-8 nbsp diff --git a/src/pyscanner.l b/src/pyscanner.l index 017cc03..d7996b4 100644 --- a/src/pyscanner.l +++ b/src/pyscanner.l @@ -1682,7 +1682,7 @@ static void initTriDoubleQuoteBlock(yyscan_t yyscanner) yyextra->docBlockContext = YY_START; yyextra->docBlockInBody = FALSE; yyextra->docBlockJavaStyle = TRUE; - yyextra->docBlockSpecial = yytext[strlen(yytext) - 1]=='!'; + yyextra->docBlockSpecial = yytext[strlen(yytext) - 1]=='!' || !Config_getBool(PYTHON_DOCSTRING); yyextra->docBlock.resize(0); yyextra->commentIndent = yyextra->curIndent; yyextra->doubleQuote = TRUE; @@ -1695,7 +1695,7 @@ static void initTriSingleQuoteBlock(yyscan_t yyscanner) yyextra->docBlockContext = YY_START; yyextra->docBlockInBody = FALSE; yyextra->docBlockJavaStyle = TRUE; - yyextra->docBlockSpecial = yytext[strlen(yytext) - 1]=='!'; + yyextra->docBlockSpecial = yytext[strlen(yytext) - 1]=='!' || !Config_getBool(PYTHON_DOCSTRING); yyextra->docBlock.resize(0); yyextra->commentIndent = yyextra->curIndent; yyextra->doubleQuote = FALSE; |