Merge branch 'master' of github.com:doxygen/doxygen

9 files changed, 26 insertions, 11 deletions

diff --git a/cmake/Sanitizers/sanitize-helpers.cmake b/cmake/Sanitizers/sanitize-helpers.cmake
index 3649b07..dd4b898 100644
--- a/cmake/Sanitizers/sanitize-helpers.cmake
+++ b/cmake/Sanitizers/sanitize-helpers.cmake
@@ -106,7 +106,7 @@ function (sanitizer_check_compiler_flags FLAG_CANDIDATES NAME PREFIX)
 
     get_property(ENABLED_LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES)
     foreach (LANG ${ENABLED_LANGUAGES})
-        # Sanitizer flags are not dependend on language, but the used compiler.
+        # Sanitizer flags are not dependent on language, but the used compiler.
         # So instead of searching flags foreach language, search flags foreach
         # compiler used.
         set(COMPILER ${CMAKE_${LANG}_COMPILER_ID})
diff --git a/doc/changelog.doc b/doc/changelog.doc
index d373487..c6235b3 100755
--- a/doc/changelog.doc
+++ b/doc/changelog.doc
@@ -5,6 +5,7 @@
 \subsection log_1_8_19 Release 1.8.19
 \htmlonly
 <b>(release date 08-08-2020)</b>
+</p>
 <h3>Bug fixes</h3>
 <ul>
 <li>issue #6846: Doxygen parsing global variable as function in certain cases (#7903) [<a href="https://github.com/doxygen/doxygen/commit/8c02f1e963682edfebfd0da619c65112cf30448b">view</a>]</li>
@@ -178,7 +179,7 @@
 <li>sqlite: flip _static default in bindTextParameter [<a href="https://github.com/doxygen/doxygen/commit/ee9a4679ae630f8f808619c5450f6b2f5a860994">view</a>]</li>
 <li>sqlite: use err instead of term :) [<a href="https://github.com/doxygen/doxygen/commit/27307c2a16139b657697ee7cb79e7d8989fbc95c">view</a>]</li>
 <li>try to make it so that argumentList is always from the definition [<a href="https://github.com/doxygen/doxygen/commit/dface804388013579f408d0baf01aa2739993317">view</a>]</li>
-<li>update URLS on README to prevent redirects [<a href="https://github.com/doxygen/doxygen/commit/28469fb1386797795a4c56ca7b75309df7ae48d6">view</a>]</ul>
+<li>update URLS on README to prevent redirects [<a href="https://github.com/doxygen/doxygen/commit/28469fb1386797795a4c56ca7b75309df7ae48d6">view</a>]</li>
 </ul>
 <p>
 \endhtmlonly
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 6c1edae..96a2621 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -450,7 +450,7 @@ the script can be found in the path set via \ref cfg_example_path "EXAMPLE_PATH"
 \subsection pythonblocks Comment blocks in Python
 
 For Python there is a standard way of documenting the code using 
-so called documentation strings. Such strings are stored in \c __doc__
+so called documentation strings (<tt>"""</tt>). Such strings are stored in \c __doc__
 and can be retrieved at runtime. Doxygen will extract such comments
 and assume they have to be represented in a preformatted way.
 
@@ -464,8 +464,12 @@ and assume they have to be represented in a preformatted way.
  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
  \endlatexonly
 
-Note that in this case none of doxygen's \ref cmd_intro "special commands" 
-are supported.
+\note When using <tt>\"\"\"</tt> none of doxygen's \ref cmd_intro "special commands" 
+are supported and the text is shown as verbatim text see \ref cmdverbatim "\\verbatim".
+To have the doxygen's \ref cmd_intro "special commands" and have the text as regular
+documentation instead of <tt>\"\"\"</tt> use <tt>\"\"\"!</tt> or set 
+\ref cfg_python_docstring "PYTHON_DOCSTRING" to \c NO in the configuration file.
+\note Instead of <tt>\"\"\"</tt> one can also use <tt>'''</tt>.
 
 There is also another way to document Python code using comments that 
 start with "##". These type of comment blocks are more in line with the 
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;
diff --git a/testing/CMakeLists.txt b/testing/CMakeLists.txt
index 1851c9f..b354e78 100644
--- a/testing/CMakeLists.txt
+++ b/testing/CMakeLists.txt
@@ -1,4 +1,4 @@
-# run all tests sequentially (keep for backward compatibilty)
+# run all tests sequentially (keep for backward compatibility)
 add_custom_target(tests
 	COMMENT "Running doxygen tests..."
 	COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_SOURCE_DIR}/testing/runtests.py --doxygen ${PROJECT_BINARY_DIR}/bin/doxygen --inputdir ${CMAKE_SOURCE_DIR}/testing --outputdir ${PROJECT_BINARY_DIR}/testing