summaryrefslogtreecommitdiffstats
path: root/templates
diff options
context:
space:
mode:
authorVladimír Vondruš <mosra@centrum.cz>2017-11-19 12:36:12 (GMT)
committerVladimír Vondruš <mosra@centrum.cz>2017-11-19 13:15:14 (GMT)
commiteaf8edbac7e6a1873aa5c4ff0df063cd367351d6 (patch)
tree4999e26ac9d19d631e120b73d64c949d3ba39538 /templates
parentebf75c1fe8a0ff2cc9235155b6d63367944d6342 (diff)
downloadDoxygen-eaf8edbac7e6a1873aa5c4ff0df063cd367351d6.zip
Doxygen-eaf8edbac7e6a1873aa5c4ff0df063cd367351d6.tar.gz
Doxygen-eaf8edbac7e6a1873aa5c4ff0df063cd367351d6.tar.bz2
Propagate language information to all <programlisting> XML elements.
This is based on work done in 141dbfd5a4f79c98da14a1b414c6db4e1b34618b through ed9acb6e1bb81a2eec334180f7b8c1bf0598b444 and makes a few behavioral changes to it. There's a new attribute called `filename` and the `language` was removed, because it could provide misleading information. This allows for more flexibility on the user side. In particular: * For historical reasons, `*.txt` files are marked by Doxygen as C++ (see https://bugzilla.gnome.org/show_bug.cgi?id=760836 for details). In particular, code snippet included from a CMakeLists.txt file would be marked and highlighted as C++. So in this case, the language attribute would be very misleading. * Doxygen is aware only of a very small subset of languages and thus a lot of information can be lost when relying on its extension-to-language-name conversion -- in particular, all extensions that are not recognized are assumed to be C++. On the other hand, putting more effort into its language detection algorithms is not worth the time, as there will always be new languages that fail to detect. So let's leave that on the user of the XML output instead. * Using just file extension is not enough, it has to be a full filename. For example, `*.txt` can be either a plain text file or a `CMakeLists.txt`. * The path is not stripped from the filename, as it also may contain additional information that helps to detect the language better. In addition to that, filenames of code snippets included via the \include command and related are propagated to the <programlisting> element as well. With this change, (1) code snippets using simply \code some code \endcode will not produce any `filename` attribute and it's up to the user what to do -- assume C++, detect language from contents or not highlight anything. <programlisting> some code </programlisting> (2) Code snippets using \code{.cmake} some code \endcode will produce the following: <programlisting filename=".cmake"> some code </programlisting> (3) And finally, \include, \dontinclude and related \skip, \skipline etc. commands \include path/to/some-file.py will produce <programlisting filename="path/to/some-file.py"> some code </programlisting> The tests were updated to check all three cases. On the user side, when using Pygments for example, it's then just a matter of calling pygments.lexers.find_lexer_class_for_filename() with value of the `filename` attribute value and optionally also the code snippet for additional language analysis.
Diffstat (limited to 'templates')
-rw-r--r--templates/xml/compound.xsd2
1 files changed, 1 insertions, 1 deletions
diff --git a/templates/xml/compound.xsd b/templates/xml/compound.xsd
index 43cc897..8affc20 100644
--- a/templates/xml/compound.xsd
+++ b/templates/xml/compound.xsd
@@ -264,7 +264,7 @@
<xsd:sequence>
<xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
- <xsd:attribute name="language" type="DoxLanguage" use="optional"/>
+ <xsd:attribute name="filename" type="xsd:string" use="optional"/>
</xsd:complexType>
<xsd:complexType name="codelineType">