mm-common-prepare, Doxyfile.in and doxygen.css



mm-common-prepare is included in many autogen.sh files. It copies some files from mm-common. One of those files is doxygen.css, which is used in Doxyfile.in, typically
HTML_STYLESHEET  = "$(MMDOCTOOLDIR)/doxygen.css"
With recent versions of doxygen, this is not the recommended way to add your own stylesheet file. It will replace doxygen's own default stylesheet. I've noticed an irritating consequence, at least with doxygen 1.8.6: The level digits in "[detail level 1 2 3 4 5]" in class lists are not clickable. Compressed parts of the lists can't be expanded. There is also a doxygen bug related to this behaviour (or lack of behaviour), https://bugzilla.gnome.org/show_bug.cgi?id=722507.

The recommended way to add your own stylesheet is to use HTML_EXTRA_STYLESHEET in Doxyfile.in.
It would be easy to make this change in one module at a time, save for one restriction: The extra stylesheet cannot be called doxygen.css. That's the name of doxygen's default stylesheet file.

Suggestion
Make a copy of mm-common/util/doxygen.css. Call it doxygen-extra.css.
Let mm-common-prepare copy both doxygen.css and
doxygen-extra.css.
Change all mm-common files where doxygen.css is mentioned. (I've found 7 files.)
Release mm-common (probably version 0.9.7). Then modules that use doxygen-extra.css can "MM_PREREQ([0.9.7])" in their configure.ac file.

After those changes in mm-common, Doxyfile.in in other modules can be modified at any time
HTML_EXTRA_STYLESHEET  = "$(MMDOCTOOLDIR)/doxygen-extra.css"
Does all this seem reasonable? Have you got a better idea?

Kjell



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]