After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 734099 - Add support for non-parsed language
Add support for non-parsed language
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: build
1.8.6
Other All
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2014-08-01 09:13 UTC by milasudril
Modified: 2014-08-25 08:33 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description milasudril 2014-08-01 09:13:19 UTC
In my documentation, I need to include code examples in languages that doxygen cannot parse. In particular it contains example in bash, batch, and vb-script and a custom turtle-like language called Spell.

The request is to add a new language ".unparsed" to \code so that the contents does not become parsed:

\code{.unparsed}
./wand-new "profile[install] files[wandcfg_install.spell]"
\endcode

Shall only emit (in HTML mode)
<blockquote class="code_unparsed">
./wand-new "profile[install] files[wandcfg_install.spell]"
</blockquote>

Also, if the chosen language is not ".unparsed", but a language not known to Doxygen, like those mentioned earlier, Doxygen shall not fallback on the default language but treat it mostly like ".unparsed":

\code{.sh}
./wand-new "profile[install] files[wandcfg_install.spell]"
\endcode

<blockquote class="code_sh">
./wand-new "profile[install] files[wandcfg_install.spell]"
</blockquote>

I do not want new to be highlighted as keyword here...
Comment 1 milasudril 2014-08-03 14:52:06 UTC
Also, it may happen that Doxygen produces bad references:

http://milasudril.github.io/gabi/html/namespace_herbs_1_1_fileutils.html

The file wandcfg-example.spell does *not* contain any information about how to use bool Herbs::Fileutils::mkdir(const Path& path). mkdir in the config file is the name of the command used to create a directory when generating a makefile.
Comment 2 Dimitri van Heesch 2014-08-04 12:13:03 UTC
Sounds like a reasonable request. I'll include this in the next GitHub update.
Comment 3 Dimitri van Heesch 2014-08-21 17:15:27 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.8. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information 
that you think can be relevant (preferrably in the form of a self-contained example).
Comment 4 milasudril 2014-08-25 08:33:09 UTC
(In reply to comment #3)
> This bug was previously marked ASSIGNED, which means it should be fixed in
> doxygen version 1.8.8. Please verify if this is indeed the case. Reopen the
> bug if you think it is not fixed and please include any additional information 
> that you think can be relevant (preferrably in the form of a self-contained
> example).

Pre-build Doxygen 1.8.8 works as expected on Microsoft Windows [Version 6.1.7601] 64-bit