Merge pull request doxygen#12235 from albert-github/feature/bug_translations

Handling of multiple `<docs>` sections in an `<option>` section

Author: doxygen

addon/doxywizard/expert.cpp

@@ -117,25 +117,32 @@ static void translateOption(QDomElement &configRoot,const QDomElement &translati
 {
   QDomElement docsVal   = configRoot.firstChildElement();
   QDomElement trDocsVal = translationRoot.firstChildElement();
-  bool first=true;
-  if (!docsVal.isNull()   && docsVal.tagName()==SA("docs") &&
-      !trDocsVal.isNull() && trDocsVal.tagName()==SA("docs"))
+  while (!docsVal.isNull() && !trDocsVal.isNull())
   {
-    //qDebug() << "id=" << configRoot.attribute(SA("id")) << "trId=" << translationRoot.attribute(SA("id"));
-    docsVal.parentNode().replaceChild(trDocsVal,docsVal);
-  }
-  docsVal = configRoot.firstChildElement().nextSiblingElement();
-  // disable options docs (already part of the translation)
-  while (!docsVal.isNull())
-  {
-    //qDebug() << "tagName" << docsVal.tagName();
     if (docsVal.tagName()==SA("docs") && getFilter(docsVal, mode))
     {
-      docsVal.removeAttribute(SA("filter"));
-      // we just need a value so we don't have an empty filter (and thus potential a match on doxywizard later on).
-      docsVal.setAttribute(SA("filter"),SA("dummy"));
+      if (trDocsVal.tagName()==SA("docs") && getFilter(trDocsVal, mode))
+      {
+        QDomNode oldText = docsVal.firstChild();
+        oldText.setNodeValue (trDocsVal.text());
+        docsVal = docsVal.nextSiblingElement();
+        trDocsVal = trDocsVal.nextSiblingElement();
+      }
+      else
+      {
+        trDocsVal = trDocsVal.nextSiblingElement();
+      }
+    }
+    else
+    {
+      docsVal = docsVal.nextSiblingElement();
     }
-    else if (docsVal.tagName()==SA("value") && docsVal.hasAttribute(SA("desc")))
+  }
+  docsVal = configRoot.firstChildElement();
+  // Just handle value tags
+  while (!docsVal.isNull())
+  {
+    if (docsVal.tagName()==SA("value") && docsVal.hasAttribute(SA("desc")))
     {
       //qDebug() << "attribute" << docsVal.attribute(SA("desc"));
       translateEnumDescription(docsVal,translationRoot);

src/config.xml

@@ -3153,11 +3153,11 @@ doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
  @note The header is subject to change so you typically
  have to regenerate the default header when upgrading to a newer version of
  Doxygen.
- The following commands have a special meaning inside the header (and footer):
 ]]>
       </docs>
       <docs filter="documentation">
 <![CDATA[
+ The following markers have a special meaning inside the header and footer:
  <dl>
  <dt><code>$title</code><dd>will be replaced with the project name.
  <dt><code>$datetime</code><dd>will be replaced with the current date and time.

src/i18n/config_de.xml

@@ -199,8 +199,15 @@
     </option>
     <option type="list" id="ALIASES" format="string">
       <docs>
-<![CDATA[Dieses Tag kann verwendet werden, um eine Reihe von Aliasnamen anzugeben, die als Befehle in der Dokumentation fungieren. Ein Alias hat die Form: \verbatim name=wert\endverbatim Zum Beispiel wurde das Hinzufügen von \verbatim "sideeffect=@par Nebeneffekte:^^"\endverbatim es Ihnen ermöglichen, den Befehl \c \sideeffect (oder \c \@sideeffect) in der Dokumentation zu platzieren, was einen benutzerdefinierten Absatz mit der Überschrift "Nebeneffekte:" erzeugt. Beachten Sie, dass Sie im Werteteil eines Alias kein \ref cmdn "\n" einfügen können, um einen Zeilenumbruch einzufügen (in der resultierenden Ausgabe). Sie können `^^` im Werteteil eines Alias einfügen, um einen Zeilenumbruch einzufügen, als ob ein physikalischer Zeilenumbruch in der Originaldatei vorhanden wäre. Wenn Sie ein wörtliches `{` oder `}` oder `,` im Werteteil eines Alias benötigen, müssen Sie diese mit einem Backslash maskieren (\c \\).]]>
+<![CDATA[Dieses Tag kann verwendet werden, um eine Reihe von Aliasnamen anzugeben, die als Befehle in der Dokumentation fungieren. Ein Alias hat die Form: \verbatim name=wert\endverbatim Zum Beispiel wurde das Hinzufügen von \verbatim "sideeffect=@par Nebeneffekte:^^"\endverbatim es Ihnen ermöglichen, den Befehl \c \sideeffect (oder \c \@sideeffect) in der Dokumentation zu platzieren, was einen benutzerdefinierten Absatz mit der Überschrift "Nebeneffekte:" erzeugt. Beachten Sie, dass Sie im Werteteil eines Alias kein \ref cmdn "\n" einfügen können, um einen Zeilenumbruch einzufügen (in der resultierenden Ausgabe). Sie können `^^` im Werteteil eines Alias einfügen, um einen Zeilenumbruch einzufügen, als ob ein physikalischer Zeilenumbruch in der Originaldatei vorhanden wäre.]]>
       </docs>
+      <docs>
+<![CDATA[
+Wenn Sie in einem Alias im Wertteil ein Literal wie `{`, `}` oder `,` benötigen, müssen Sie diese
+mit einem Backslash (\c \\) maskieren. Dies kann zu Konflikten mit den
+Befehlen \c \\{ und \c \\} führen. Für diese empfiehlt es sich, die Versionen \c @@{ und \c @@} zu verwenden oder
+eine doppelte Maskierung (\c \\\\{ und \c \\\\}) zu verwenden.]]>
+    </docs>
     </option>
     <option type="bool" id="OPTIMIZE_OUTPUT_FOR_C" defval="0">
       <docs>
@@ -544,7 +551,12 @@
     </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.]]>
+      </docs>
+      <docs filter="doxyfile,doxywizard">
+<![CDATA[
+ Für ein Beispiel siehe die Dokumentation.
+ ]]>
       </docs>
     </option>
     <option type="string" id="LAYOUT_FILE" format="file" defval="">
@@ -879,7 +891,12 @@
     </option>
     <option type="string" id="HTML_HEADER" format="file" defval="" depends="GENERATE_HTML">
       <docs>
-<![CDATA[Das \c HTML_HEADER-Tag kann verwendet werden, um eine benutzerdefinierte HTML-Header-Datei für jede generierte HTML-Seite anzugeben. Wenn das Tag leer gelassen wird, generiert Doxygen einen Standard-Header. <br>Um gültiges HTML zu erhalten, muss die Header-Datei alle Skripte und Stylesheets enthalten, die Doxygen benötigt, was von den verwendeten Konfigurationsoptionen abhängt (z.B. die Einstellung \ref cfg_generate_treeview "GENERATE_TREEVIEW"). Es wird dringend empfohlen, mit einem Standard-Header zu beginnen, indem Sie \verbatim doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile \endverbatim verwenden und dann die Datei \c new_header.html ändern. Siehe auch Abschnitt \ref doxygen_usage für Informationen zum Generieren des Standard-Headers, den Doxygen normalerweise verwendet. @note Der Header kann sich ändern, daher müssen Sie normalerweise den Standard-Header regenerieren, wenn Sie auf eine neuere Version von Doxygen aktualisieren. Für eine Beschreibung der möglichen Marker und Blocknamen siehe die Dokumentation.]]>
+<![CDATA[Das \c HTML_HEADER-Tag kann verwendet werden, um eine benutzerdefinierte HTML-Header-Datei für jede generierte HTML-Seite anzugeben. Wenn das Tag leer gelassen wird, generiert Doxygen einen Standard-Header. <br>Um gültiges HTML zu erhalten, muss die Header-Datei alle Skripte und Stylesheets enthalten, die Doxygen benötigt, was von den verwendeten Konfigurationsoptionen abhängt (z.B. die Einstellung \ref cfg_generate_treeview "GENERATE_TREEVIEW"). Es wird dringend empfohlen, mit einem Standard-Header zu beginnen, indem Sie \verbatim doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFile \endverbatim verwenden und dann die Datei \c new_header.html ändern. Siehe auch Abschnitt \ref doxygen_usage für Informationen zum Generieren des Standard-Headers, den Doxygen normalerweise verwendet. @note Der Header kann sich ändern, daher müssen Sie normalerweise den Standard-Header regenerieren, wenn Sie auf eine neuere Version von Doxygen aktualisieren.]]>
+      </docs>
+      <docs filter="doxyfile,doxywizard">
+<![CDATA[
+ Für eine Beschreibung der möglichen Marker und Blocknamen siehe die Dokumentation.
+ ]]>
       </docs>
     </option>
     <option type="string" id="HTML_FOOTER" format="file" defval="" depends="GENERATE_HTML">
@@ -894,7 +911,12 @@
     </option>
     <option type="list" id="HTML_EXTRA_STYLESHEET" format="file" defval="" depends="GENERATE_HTML">
       <docs>
-<![CDATA[Das \c HTML_EXTRA_STYLESHEET-Tag kann verwendet werden, um zusätzliche benutzerdefinierte Cascading Stylesheets anzugeben, die nach den von Doxygen erstellten Standard-Stylesheets eingebunden werden. Mit dieser Option können bestimmte Stilaspekte überschrieben werden. Dies ist der Verwendung von \ref cfg_html_stylesheet "HTML_STYLESHEET" vorzuziehen, da es das Standard-Stylesheet nicht ersetzt und daher robuster gegen zukünftige Updates ist. Doxygen kopiert die Stylesheet-Dateien in das Ausgabeverzeichnis. \note Die Reihenfolge der zusätzlichen Stylesheet-Dateien ist wichtig (z.B. überschreibt das letzte Stylesheet in der Liste die Einstellungen der vorherigen in der Liste). \note Da die Gestaltung von Scrollleisten in Webkit/Chromium derzeit nicht überschrieben werden kann, wird die Gestaltung aus der Standard-datei doxygen.css weggelassen, wenn ein oder mehrere zusätzliche Stylesheets angegeben wurden. Wenn also eine Anpassung der Scrollleisten gewünscht wird, muss diese explizit hinzugefügt werden. Für ein Beispiel siehe die Dokumentation.]]>
+<![CDATA[Das \c HTML_EXTRA_STYLESHEET-Tag kann verwendet werden, um zusätzliche benutzerdefinierte Cascading Stylesheets anzugeben, die nach den von Doxygen erstellten Standard-Stylesheets eingebunden werden. Mit dieser Option können bestimmte Stilaspekte überschrieben werden. Dies ist der Verwendung von \ref cfg_html_stylesheet "HTML_STYLESHEET" vorzuziehen, da es das Standard-Stylesheet nicht ersetzt und daher robuster gegen zukünftige Updates ist. Doxygen kopiert die Stylesheet-Dateien in das Ausgabeverzeichnis. \note Die Reihenfolge der zusätzlichen Stylesheet-Dateien ist wichtig (z.B. überschreibt das letzte Stylesheet in der Liste die Einstellungen der vorherigen in der Liste). \note Da die Gestaltung von Scrollleisten in Webkit/Chromium derzeit nicht überschrieben werden kann, wird die Gestaltung aus der Standard-datei doxygen.css weggelassen, wenn ein oder mehrere zusätzliche Stylesheets angegeben wurden. Wenn also eine Anpassung der Scrollleisten gewünscht wird, muss diese explizit hinzugefügt werden.]]>
+      </docs>
+      <docs filter="doxyfile,doxywizard">
+<![CDATA[
+ Für ein Beispiel siehe die Dokumentation.
+ ]]>
       </docs>
     </option>
     <option type="list" id="HTML_EXTRA_FILES" format="file" depends="GENERATE_HTML">
@@ -1161,7 +1183,7 @@
       <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">
+    <option type="string" id="MATHJAX_RELPATH" format="string" depends="USE_MATHJAX">
       <docs>
 <![CDATA[
  Wenn MathJax aktiviert ist, müssen Sie den Speicherort relativ zum HTML-Ausgabeverzeichnis
@@ -1188,7 +1210,12 @@
     </option>
     <option type="string" id="MATHJAX_CODEFILE" format="string" depends="USE_MATHJAX">
       <docs>
-<![CDATA[Das \c MATHJAX_CODEFILE-Tag kann verwendet werden, um eine Datei mit JavaScript-Code-Stucken anzugeben, die beim Start des MathJax-Codes verwendet werden. Siehe die MathJax-Website für weitere Details: - <a href="https://docs.mathjax.org/en/v2.7/">MathJax version 2</a> - <a href="https://docs.mathjax.org/en/v3.2/">MathJax version 3</a> - <a href="https://docs.mathjax.org/en/v4.0/">MathJax version 4</a> Für ein Beispiel siehe die Dokumentation.]]>
+<![CDATA[Das \c MATHJAX_CODEFILE-Tag kann verwendet werden, um eine Datei mit JavaScript-Code-Stucken anzugeben, die beim Start des MathJax-Codes verwendet werden. Siehe die MathJax-Website für weitere Details: - <a href="https://docs.mathjax.org/en/v2.7/">MathJax version 2</a> - <a href="https://docs.mathjax.org/en/v3.2/">MathJax version 3</a> - <a href="https://docs.mathjax.org/en/v4.0/">MathJax version 4</a>]]>
+      </docs>
+      <docs filter="doxyfile,doxywizard">
+<![CDATA[
+ Für ein Beispiel siehe die Dokumentation.
+ ]]>
       </docs>
     </option>
     <option type="bool" id="SEARCHENGINE" defval="1" depends="GENERATE_HTML">
@@ -1274,7 +1301,12 @@
     </option>
     <option type="string" id="LATEX_HEADER" format="file" defval="" depends="GENERATE_LATEX">
       <docs>
-<![CDATA[Das \c LATEX_HEADER-Tag kann verwendet werden, um einen benutzerdefinierten \f$\mbox{\LaTeX}\f$-Header für das generierte \f$\mbox{\LaTeX}\f$-Dokument anzugeben. Der Header sollte alles bis zum ersten Kapitel enthalten. Wenn er leer gelassen wird, generiert Doxygen einen Standard-Header. Es wird dringend empfohlen, mit einem Standard-Header zu beginnen, indem Sie \verbatim doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty \endverbatim verwenden und dann die Datei \c new_header.tex ändern. Siehe auch Abschnitt \ref doxygen_usage für Informationen zum Generieren des Standard-Headers, den Doxygen normalerweise verwendet. <br>Hinweis: Verwenden Sie nur einen benutzerdefinierten Header, wenn Sie wissen, was Sie tun! @note Der Header kann sich ändern, daher müssen Sie normalerweise den Standard-Header regenerieren, wenn Sie auf eine neuere Version von Doxygen aktualisieren. Für eine Beschreibung der möglichen Marker und Blocknamen siehe die Dokumentation.]]>
+<![CDATA[Das \c LATEX_HEADER-Tag kann verwendet werden, um einen benutzerdefinierten \f$\mbox{\LaTeX}\f$-Header für das generierte \f$\mbox{\LaTeX}\f$-Dokument anzugeben. Der Header sollte alles bis zum ersten Kapitel enthalten. Wenn er leer gelassen wird, generiert Doxygen einen Standard-Header. Es wird dringend empfohlen, mit einem Standard-Header zu beginnen, indem Sie \verbatim doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty \endverbatim verwenden und dann die Datei \c new_header.tex ändern. Siehe auch Abschnitt \ref doxygen_usage für Informationen zum Generieren des Standard-Headers, den Doxygen normalerweise verwendet. <br>Hinweis: Verwenden Sie nur einen benutzerdefinierten Header, wenn Sie wissen, was Sie tun! @note Der Header kann sich ändern, daher müssen Sie normalerweise den Standard-Header regenerieren, wenn Sie auf eine neuere Version von Doxygen aktualisieren.]]>
+      </docs>
+      <docs filter="doxyfile,doxywizard">
+<![CDATA[
+ Für eine Beschreibung der möglichen Marker und Blocknamen siehe die Dokumentation.
+ ]]>
       </docs>
     </option>
     <option type="string" id="LATEX_FOOTER" format="file" defval="" depends="GENERATE_LATEX">