chiark / gitweb /
doxygen: JAVADOC_AUTOBRIEF is... wow. I need to take a shower.
authorVladimír Vondruš <mosra@centrum.cz>
Wed, 25 Apr 2018 11:40:23 +0000 (13:40 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Wed, 25 Apr 2018 12:35:52 +0000 (14:35 +0200)
commit406ecd7427081b62dc6787f2611eeee48ca4f500
tree4392cbb8cdb092a3e078990f157dd67b62d36d37
parente93df33fabf9ee5d627eaf1d6e0256bac33ffcdc
doxygen: JAVADOC_AUTOBRIEF is... wow. I need to take a shower.

Or, don't blow up on an unfortunate series of bad events.

1. If a file has a copyright header starting with /// and delimited with
   **** and JAVADOC_AUTOBRIEF is set to ON, Doxygen treats the first ***
   line as a brief documentation, which then made m.css fail because it
   doesn't expect stuff like <para><hruler/></para> inside
   <briefdescriptions>. The <hruler/> is still not implemented yet,
   though.

2. Who would have thought that

       /// A brief docs.
       /// @{
       /// Some detailed docs.

   would be understood as a two-paragraph brief?!

3. And who would have thought that

       /// ============
       /// The Thing
       /// ============

    would create a brief containing some === characters and a <heading>
    inside?! Here I just give up and ignore the whole thing.
doxygen/dox2html5.py
doxygen/test/contents_autobrief_heading/Doxyfile [new file with mode: 0644]
doxygen/test/contents_autobrief_heading/File.h [new file with mode: 0644]
doxygen/test/contents_autobrief_heading/namespaceNamespace.html [new file with mode: 0644]
doxygen/test/contents_autobrief_hr/Doxyfile [new file with mode: 0644]
doxygen/test/contents_autobrief_hr/File.h [new file with mode: 0644]
doxygen/test/contents_autobrief_hr/namespaceNamespace.html [new file with mode: 0644]
doxygen/test/contents_autobrief_multiline/Doxyfile [new file with mode: 0644]
doxygen/test/contents_autobrief_multiline/File.h [new file with mode: 0644]
doxygen/test/contents_autobrief_multiline/namespaceNamespace.html [new file with mode: 0644]
doxygen/test/test_contents.py