Merge pull request doxygen#12197 from albert-github/feature/bug_dw_display_docu

Improve display of documentation in doxywizard

Author: doxygen

addon/doxywizard/expert.cpp

@@ -1022,18 +1022,28 @@ QString Expert::getDocsForNode(const QDomElement &child) const
   regexp.setPattern(SA("<br> *$"));
   docs.replace(regexp,SA(" "));
   docs.replace(SA("(\\c \\\\)"),SA("(\\c JUST_WIZARD_BACKSLASH)"));
-  // \c word -> <code>word</code>; word ends with ')', ',', '.' or ' '
-  regexp.setPattern(SA("\\\\c[ ]+([^ \\)]+)\\)"));
-  docs.replace(regexp,SA("<code>\\1</code>)"));
 
-  regexp.setPattern(SA("\\\\c[ ]+([^ ,]+),"));
-  docs.replace(regexp,SA("<code>\\1</code>,"));
+  regexp.setPattern(SA("\\\\c[ ]+([A-Za-z]+\\.[a-z]+\\.[a-z]+\\.[a-z]+)"));
+  docs.replace(regexp,SA("<code>\\1</code>"));
 
-  regexp.setPattern(SA("\\\\c[ ]+([^ \\.]+)\\."));
-  docs.replace(regexp,SA("<code>\\1</code>."));
+  regexp.setPattern(SA("\\\\c[ ]+([A-Za-z]+\\.[a-z]+)"));
+  docs.replace(regexp,SA("<code>\\1</code>"));
+
+  regexp.setPattern(SA("\\\\c[ ]+(\\\\#[a-z]+)"));
+  docs.replace(regexp,SA("<code>\\1</code>"));
+
+  regexp.setPattern(SA("\\\\c[ ]+(\\\\[@\\\\])?([%=!\\\"/A-Za-z0-9_]+)(\\([0-9]*\\))?"));
+  docs.replace(regexp,SA("<code>\\1\\2\\3</code>"));
+
+  regexp.setPattern(SA("\\\\c[ ]+(\\\\\\\\[{}])"));
+  docs.replace(regexp,SA("<code>\\1</code>"));
+
+  regexp.setPattern(SA("\\\\c[ ]+(\\\\\\\\\\\\\\\\[{}])"));
+  docs.replace(regexp,SA("<code>\\1</code>"));
+
+  regexp.setPattern(SA("\\\\c[ ]+(@[{}])"));
+  docs.replace(regexp,SA("<code>\\1</code>"));
 
-  regexp.setPattern(SA("\\\\c[ ]+([^ ]+) "));
-  docs.replace(regexp,SA("<code>\\1</code> "));
   // `word` -> <code>word</code>
   docs.replace(SA("``"),SA(""));
   regexp.setPattern(SA("`([^`]+)`"));

src/config.xml

@@ -1338,8 +1338,8 @@ Go to the <a href="commands.html">next</a> section or return to the
  The \c FILE_VERSION_FILTER tag can be used to specify a program or script that
  Doxygen should invoke to get the current version for each file (typically from the
  version control system). Doxygen will invoke the program by executing (via
- <code>popen()</code>) the command <code>command input-file</code>, where \c command is
- the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name
+ <code>popen()</code>) the command <code>command input_file</code>, where \c command is
+ the value of the \c FILE_VERSION_FILTER tag, and \c input_file is the name
  of an input file provided by Doxygen.
  Whatever the program writes to standard output is used as the file version.
 ]]>
@@ -1445,7 +1445,7 @@ PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
  generated to standard error (\c stderr) by Doxygen. If \c WARNINGS is set to
  \c YES this implies that the warnings are on.
 <br>
- \b Tip: Turn warnings on while writing the documentation.
+ <b>Tip:</b> Turn warnings on while writing the documentation.
 ]]>
       </docs>
     </option>
@@ -2859,7 +2859,7 @@ obfuscate email addresses.
       </docs>
       <value name="HTML-CSS" desc="(which is slower, but has the best compatibility. This is the name for Mathjax version 2, for MathJax version 3 this will be translated into \c chtml)"/>
       <value name="NativeMML" desc="(i.e. MathML. Only supported for MathJax 2. For MathJax version 3 \c chtml will be used instead.)"/>
-      <value name="chtml" desc="(This is the name for Mathjax version 3, for MathJax version 2 this will be translated into \c HTML-CSS)"/>
+      <value name="chtml" desc="(This is the name for Mathjax version 3, for MathJax version 2 this will be translated into &lt;code&gt;HTML-CSS&lt;/code&gt;)"/>
       <value name="SVG"/>
     </option>
     <option type='string' id='MATHJAX_RELPATH' format='string' depends='USE_MATHJAX'>
@@ -3793,8 +3793,7 @@ Adding location for the tag files is done as follows:
 where `loc1` and `loc2` can be relative or absolute paths or URLs.
  See the section \ref external for more information about the use of tag files.
 
- \note
-  Each tag file must have a unique name
+ \note Each tag file must have a unique name
   (where the name does \e NOT include the path).
   If a tag file is not located in the directory in which Doxygen
   is run, you must also specify the path to the tagfile here.
@@ -4292,7 +4291,7 @@ to be found in the default search path.
 ]]>
       </docs>
       <value name='AUTO' desc='(use client-side rendering for HTML and \c mmdc for LaTeX/PDF and other formats. If \c MERMAID_PATH is not set, non-HTML diagrams will produce a warning)'/>
-      <value name='CLI' desc='(use the \c mmdc tool to pre-generate images (requires \c Node.js and \c mermaid-js/mermaid-cli). Works for all output formats)'/>
+      <value name='CLI' desc='(use the \c mmdc tool to pre-generate images (requires \c Node.js and &lt;code&gt;mermaid-js/mermaid-cli&lt;/code&gt;). Works for all output formats)'/>
       <value name='CLIENT_SIDE' desc='(embed \c mermaid.js in HTML output for client-side rendering. Does not require \c mmdc but only works for HTML output)'/>
     </option>
     <option type='string' id='MERMAID_JS_URL' format='string'

src/configgen.py

@@ -62,6 +62,8 @@ def transformDocs(doc):
     doc = doc.replace("\\note ", "\n"+messages['notetxt']+" ")
     doc = doc.replace("\\verbatim", "\n")
     doc = doc.replace("\\endverbatim", "\n")
+    doc = doc.replace("<b>", "")
+    doc = doc.replace("</b>", "")
     doc = doc.replace("<code>", "")
     doc = doc.replace("</code>", "")
     doc = doc.replace("`", "")

src/i18n/config_de.xml

@@ -544,7 +544,7 @@
     </option>
     <option type="string" id="FILE_VERSION_FILTER" format="file" defval="">
       <docs>
-<![CDATA[Das \c FILE_VERSION_FILTER-Tag kann verwendet werden, um ein Programm oder Skript anzugeben, das Doxygen aufrufen soll, um die aktuelle Version für jede Datei zu erhalten (typischerweise vom Versionskontrollsystem). Doxygen ruft das Programm auf, indem es (über <code>popen()</code>) den Befehl <code>command input-file</code> ausführt, wobei \c command der Wert des \c FILE_VERSION_FILTER-Tags ist und \c input-file der Name einer von Doxygen bereitgestellten Eingabedatei ist. Was auch immer das Programm auf die Standardausgabe schreibt, wird als Dateiversion verwendet. Für ein Beispiel siehe die Dokumentation.]]>
+<![CDATA[Das \c FILE_VERSION_FILTER-Tag kann verwendet werden, um ein Programm oder Skript anzugeben, das Doxygen aufrufen soll, um die aktuelle Version für jede Datei zu erhalten (typischerweise vom Versionskontrollsystem). Doxygen ruft das Programm auf, indem es (über <code>popen()</code>) den Befehl <code>command input_file</code> ausführt, wobei \c command der Wert des \c FILE_VERSION_FILTER-Tags ist und \c input_file der Name einer von Doxygen bereitgestellten Eingabedatei ist. Was auch immer das Programm auf die Standardausgabe schreibt, wird als Dateiversion verwendet. Für ein Beispiel siehe die Dokumentation.]]>
       </docs>
     </option>
     <option type="string" id="LAYOUT_FILE" format="file" defval="">
@@ -571,7 +571,7 @@
     </option>
     <option type="bool" id="WARNINGS" defval="1">
       <docs>
-<![CDATA[Das \c WARNINGS-Tag kann verwendet werden, um die Warnmeldungen ein- oder auszuschalten, die von Doxygen auf die Standardfehlerausgabe (\c stderr) generiert werden. Wenn \c WARNINGS auf \c YES gesetzt ist, bedeutet dies, dass die Warnungen eingeschaltet sind. <br> \b Tipp: Schalten Sie Warnungen ein, während Sie die Dokumentation schreiben.]]>
+<![CDATA[Das \c WARNINGS-Tag kann verwendet werden, um die Warnmeldungen ein- oder auszuschalten, die von Doxygen auf die Standardfehlerausgabe (\c stderr) generiert werden. Wenn \c WARNINGS auf \c YES gesetzt ist, bedeutet dies, dass die Warnungen eingeschaltet sind. <br> <b>Tipp:</b> Schalten Sie Warnungen ein, während Sie die Dokumentation schreiben.]]>
       </docs>
     </option>
     <option type="bool" id="WARN_IF_UNDOCUMENTED" defval="1">
@@ -1158,7 +1158,7 @@
       </docs>
       <value name="HTML-CSS" desc="(langsamer, aber mit bester Kompatibilität. Dies ist der Name für MathJax Version 2, für MathJax Version 3 wird dies in \c chtml übersetzt)"/>
       <value name="NativeMML" desc="(d.h. MathML. Nur für MathJax 2 unterstützt. Für MathJax Version 3 wird stattdessen \c chtml verwendet.)"/>
-      <value name="chtml" desc="(Dies ist der Name für MathJax Version 3, für MathJax Version 2 wird dies in \c HTML-CSS übersetzt)"/>
+      <value name="chtml" desc="(Dies ist der Name für MathJax Version 3, für MathJax Version 2 wird dies in &lt;code&gt;HTML-CSS&lt;/code&gt; übersetzt)"/>
       <value name="SVG"/>
     </option>
         <option type="string" id="MATHJAX_RELPATH" format="string" depends="USE_MATHJAX">
@@ -1523,7 +1523,7 @@
   <group name="External" trname="Externe Referenzen" docs="Konfigurationsoptionen für externe Referenzen">
     <option type="list" id="TAGFILES" format="file">
       <docs>
-<![CDATA[Das \c TAGFILES-Tag kann verwendet werden, um eine oder mehrere Tag-Dateien anzugeben. Für jede Tag-Datei sollte der Speicherort der externen Dokumentation hinzugefügt werden. Das Format einer Tag-Datei ohne diesen Speicherort ist wie folgt: \verbatim TAGFILES = file1 file2 ... \endverbatim Das Hinzufügen des Speicherorts für die Tag-Dateien erfolgt wie folgt: \verbatim TAGFILES = file1=loc1 "file2 = loc2" ... \endverbatim wobei `loc1` und `loc2` relative oder absolute Pfade oder URLs sein können. Siehe den Abschnitt \ref external für weitere Informationen zur Verwendung von Tag-Dateien. \note Jede Tag-Datei muss einen eindeutigen Namen haben (wobei der Name den Pfad NICHT enthält). Wenn eine Tag-Datei nicht in dem Verzeichnis liegt, in dem Doxygen ausgeführt wird, müssen Sie auch den Pfad zur Tag-Datei hier angeben.]]>
+<![CDATA[Das \c TAGFILES-Tag kann verwendet werden, um eine oder mehrere Tag-Dateien anzugeben. Für jede Tag-Datei sollte der Speicherort der externen Dokumentation hinzugefügt werden. Das Format einer Tag-Datei ohne diesen Speicherort ist wie folgt: \verbatim TAGFILES = file1 file2 ... \endverbatim Das Hinzufügen des Speicherorts für die Tag-Dateien erfolgt wie folgt: \verbatim TAGFILES = file1=loc1 "file2 = loc2" ... \endverbatim wobei `loc1` und `loc2` relative oder absolute Pfade oder URLs sein können. Siehe den Abschnitt \ref external für weitere Informationen zur Verwendung von Tag-Dateien. \note Jede Tag-Datei muss einen eindeutigen Namen haben (wobei der Name den Pfad \e NICHT enthält). Wenn eine Tag-Datei nicht in dem Verzeichnis liegt, in dem Doxygen ausgeführt wird, müssen Sie auch den Pfad zur Tag-Datei hier angeben.]]>
       </docs>
     </option>
     <option type="string" id="GENERATE_TAGFILE" format="file" defval="">
@@ -1780,7 +1780,7 @@
 <![CDATA[Das \c MERMAID_RENDER_MODE-Tag steuert, wie Mermaid-Diagramme gerendert werden. Mögliche Werte sind: \c CLI (verwendet das `mmdc`-Tool von der Befehlszeile), \c CLIENT (verwendet mermaid.js im Browser) oder \c SERVER (verwendet mermaid.ink als externen Dienst). Standardmäßig ist dies auf \c CLIENT gesetzt.]]>
       </docs>
       <value name="AUTO" desc="(verwendet Client-Side-Rendering für HTML und \c mmdc für LaTeX/PDF und andere Formate. Wenn \c MERMAID_PATH nicht gesetzt ist, erzeugen Nicht-HTML-Diagramme eine Warnung)"/>
-      <value name="CLI" desc="(verwendet das \c mmdc-Tool zum Vorgenerieren von Bildern (erfordert \c Node.js und \c mermaid-js/mermaid-cli). Funktioniert für alle Ausgabeformate)"/>
+      <value name="CLI" desc="(verwendet das \c mmdc-Tool zum Vorgenerieren von Bildern (erfordert \c Node.js und &lt;code&gt;mermaid-js/mermaid-cli&lt;/code&gt;). Funktioniert für alle Ausgabeformate)"/>
       <value name="CLIENT_SIDE" desc="(bettet \c mermaid.js in die HTML-Ausgabe für Client-Side-Rendering ein. Erfordert kein \c mmdc, funktioniert aber nur für HTML-Ausgabe)"/>
     </option>
     <option type="string" id="MERMAID_JS_URL" format="string" defval="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs">

src/i18n/config_es.xml

@@ -545,7 +545,7 @@
     </option>
     <option type="string" id="FILE_VERSION_FILTER" format="file" defval="">
       <docs>
-<![CDATA[La etiqueta \c FILE_VERSION_FILTER se puede usar para especificar un programa o script que Doxygen debe invocar para obtener la versión actual de cada archivo (típicamente del sistema de control de versiones). Doxygen invocará el programa ejecutando (via <code>popen()</code>) el comando <code>command input-file</code>, donde \c command es el valor de la etiqueta \c FILE_VERSION_FILTER y \c input-file es el nombre de un archivo de entrada proporcionado por Doxygen. Lo que sea que el programa escriba en la salida estándar se usará como la versión del archivo. Para un ejemplo, vea la documentación.]]>
+<![CDATA[La etiqueta \c FILE_VERSION_FILTER se puede usar para especificar un programa o script que Doxygen debe invocar para obtener la versión actual de cada archivo (típicamente del sistema de control de versiones). Doxygen invocará el programa ejecutando (via <code>popen()</code>) el comando <code>command input_file</code>, donde \c command es el valor de la etiqueta \c FILE_VERSION_FILTER y \c input_file es el nombre de un archivo de entrada proporcionado por Doxygen. Lo que sea que el programa escriba en la salida estándar se usará como la versión del archivo. Para un ejemplo, vea la documentación.]]>
       </docs>
     </option>
     <option type="string" id="LAYOUT_FILE" format="file" defval="">
@@ -572,7 +572,7 @@
     </option>
     <option type="bool" id="WARNINGS" defval="1">
       <docs>
-<![CDATA[La etiqueta \c WARNINGS se puede usar para activar/desactivar los mensajes de advertencia generados a la salida de error estándar (\c stderr) por Doxygen. Si \c WARNINGS está configurado en \c YES, esto implica que las advertencias están activadas. <br> \b Consejo: Active las advertencias mientras escribe la documentación.]]>
+<![CDATA[La etiqueta \c WARNINGS se puede usar para activar/desactivar los mensajes de advertencia generados a la salida de error estándar (\c stderr) por Doxygen. Si \c WARNINGS está configurado en \c YES, esto implica que las advertencias están activadas. <br> <b>Consejo:</b> Active las advertencias mientras escribe la documentación.]]>
       </docs>
     </option>
     <option type="bool" id="WARN_IF_UNDOCUMENTED" defval="1">
@@ -1159,7 +1159,7 @@
       </docs>
       <value name="HTML-CSS" desc="(más lento, pero con mejor compatibilidad. Este es el nombre para MathJax versión 2, para MathJax versión 3 se traducirá a \c chtml)"/>
       <value name="NativeMML" desc="(es decir, MathML. Solo compatible con MathJax 2. Para MathJax versión 3 se usará \c chtml en su lugar.)"/>
-      <value name="chtml" desc="(Este es el nombre para MathJax versión 3, para MathJax versión 2 se traducirá a \c HTML-CSS)"/>
+      <value name="chtml" desc="(Este es el nombre para MathJax versión 3, para MathJax versión 2 se traducirá a &lt;code&gt;HTML-CSS&lt;/code&gt;)"/>
       <value name="SVG"/>
     </option>
         <option type="string" id="MATHJAX_RELPATH" format="string" depends="USE_MATHJAX">
@@ -1524,7 +1524,7 @@
   <group name="External" trname="Referencias externas" docs="Opciones de configuración relacionadas con las referencias externas">
     <option type="list" id="TAGFILES" format="file">
       <docs>
-<![CDATA[La etiqueta \c TAGFILES se puede usar para especificar uno o más archivos de etiquetas. Para cada archivo de etiquetas se debe agregar la ubicación de la documentación externa. El formato de un archivo de etiquetas sin esta ubicación es el siguiente: \verbatim TAGFILES = file1 file2 ... \endverbatim Agregar ubicación para los archivos de etiquetas se hace de la siguiente manera: \verbatim TAGFILES = file1=loc1 "file2 = loc2" ... \endverbatim donde `loc1` y `loc2` pueden ser rutas relativas o absolutas o URLs. Vea la sección \ref external para más información sobre el uso de archivos de etiquetas. \note Cada archivo de etiquetas debe tener un nombre único (donde el nombre NO incluye la ruta). Si un archivo de etiquetas no está ubicado en el directorio en el que se ejecuta Doxygen, también debe especificar la ruta al archivo de etiquetas aquí.]]>
+<![CDATA[La etiqueta \c TAGFILES se puede usar para especificar uno o más archivos de etiquetas. Para cada archivo de etiquetas se debe agregar la ubicación de la documentación externa. El formato de un archivo de etiquetas sin esta ubicación es el siguiente: \verbatim TAGFILES = file1 file2 ... \endverbatim Agregar ubicación para los archivos de etiquetas se hace de la siguiente manera: \verbatim TAGFILES = file1=loc1 "file2 = loc2" ... \endverbatim donde `loc1` y `loc2` pueden ser rutas relativas o absolutas o URLs. Vea la sección \ref external para más información sobre el uso de archivos de etiquetas. \note Cada archivo de etiquetas debe tener un nombre único (donde el nombre \e NO incluye la ruta). Si un archivo de etiquetas no está ubicado en el directorio en el que se ejecuta Doxygen, también debe especificar la ruta al archivo de etiquetas aquí.]]>
       </docs>
     </option>
     <option type="string" id="GENERATE_TAGFILE" format="file" defval="">
@@ -1781,7 +1781,7 @@
 <![CDATA[La etiqueta \c MERMAID_RENDER_MODE controla cómo se renderizan los diagramas Mermaid.]]>
       </docs>
       <value name="AUTO" desc="(usar renderizado del lado del cliente para HTML y \c mmdc para LaTeX/PDF y otros formatos. Si \c MERMAID_PATH no está configurado, los diagramas no HTML producirán una advertencia)"/>
-      <value name="CLI" desc="(usar la herramienta \c mmdc para pregenerar imagenes (requiere \c Node.js y \c mermaid-js/mermaid-cli). Funciona para todos los formatos de salida)"/>
+      <value name="CLI" desc="(usar la herramienta \c mmdc para pregenerar imagenes (requiere \c Node.js y &lt;code&gt;mermaid-js/mermaid-cli&lt;/code&gt;). Funciona para todos los formatos de salida)"/>
       <value name="CLIENT_SIDE" desc="(incrustar \c mermaid.js en la salida HTML para renderizado del lado del cliente. No requiere \c mmdc pero solo funciona para salida HTML)"/>
     </option>
     <option type="string" id="MERMAID_JS_URL" format="string" defval="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs">