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 766069 - Files with incorrect extensions (.doc) are picked up by doxygen
Files with incorrect extensions (.doc) are picked up by doxygen
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.11
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2016-05-06 16:07 UTC by Jeroen Van Antwerpen
Modified: 2016-09-05 13:46 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Jeroen Van Antwerpen 2016-05-06 16:07:11 UTC
When trying to upgrade from doxygen 1.8.10 to 1.8.11 we noticed that doxygen is becoming very confused. It tried to create files with non-printable characters, like character 0x0F.

After some searching, we noticed that in the generation of the globals.xhtml and globals_<firstchar>.xhtml files there was a reference to a .doc file which was part of the code base.

On trying to do something similar with our config, we noticed the same problems with a blank .doc file, though not with a .docx file. Further investigation is still required, though it looks like the files which are picked up by doxygen have been changed between 1.8.10 and 1.8.11. (However I don't find this in the change log)

Most important part of our configuration: (I'll try to update the local configuration, though as generation of documentation takes hours, this takes time)

# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.

FILE_PATTERNS          =
Comment 1 Dimitri van Heesch 2016-05-06 19:13:12 UTC
I think the issue is introduced by this commit:
https://github.com/doxygen/doxygen/pull/383/files

The new list of extensions does not match the old list. In particular for the .doc extension.

As a workaround you could specify the extensions you want doxygen to process explicitly.
Comment 2 Jeroen Van Antwerpen 2016-05-09 10:18:34 UTC
I've verified this.
If you set FILE_PATTERNS to the expected extensions, the generation is successful.

Important to note here is that the different patterns have to be separated by blanks instead of commas. This makes the 'If left blank' part a bit confusing.

For now, we'll specify these extensions explicitly until resolved.
Comment 3 Dimitri van Heesch 2016-05-16 15:06:48 UTC
Should be corrected in the next GIT update.
Comment 4 Dimitri van Heesch 2016-09-05 13:46:37 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.12. 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 (preferably in the form of a self-contained example).