Hi list;
As stated on Github[1], I would like to add an option behaving similarly
to compilers' -Werror option: any warning generated during Doxygen
execution will abort it immediately.
This option is, in my opinion, valuable to keep documentation up-to-date
with code changes, specially when multiple people are working altogether.
I will not blame anyone to not think all consequence of a code change,
but scripts can help him/her from breaking anything:
* strict compiler options (-Werror, -Wall, etc.) prevents at least some
quick&dirty code and obvious bugs. Compilers will warn beginners about
code which will not work (out of bounds errors, etc.), but most of the
time it's simply about a typo / useless dead code.
* Git hook preventing users from pushing invalid commits [2]. We are
intensively using git submodules for instance - it's quite easy to push
an invalid submodule reference to git:
* if you forgot to run "git submodule update --recursive" after
pulling remote changes following by a "git commit -a", leading to
unwilling submodule downgrading.
* if you're referencing a new submodule revision... which you
forgot to push first!
* To have better code consistency, following a single code style using
clang-format[3], similarly to what systemd does[4].
I think that all of us already encountered one or several of these
issues at least once ;-). Having tools checking these errors
automatically allow me not to worry about it anymore.
Our documentation contains nowadays many errors simply because Doxygen
let us do that and we did not look at """inoffensive""" warnings, since
they are not preventing us from continuing - they are lost in the
verbosity of build logs.
I am the only one which would like such an option, and if so: how do you
keep your documentation up-to-date?
Cheers,
Gautier
[1] https://github.com/doxygen/doxygen/pull/412
[2] https://gist.github.com/bagage/bdca3d4b66d43db7a5e3
[3] http://clang.llvm.org/docs/ClangFormat.html
[4] https://github.com/systemd/systemd/blob/master/autogen.sh
------------------------------------------------------------------------------
Go from Idea to Many App Stores Faster with Intel(R) XDK
Give your users amazing mobile app experiences with Intel(R) XDK.
Use one codebase in this all-in-one HTML5 development environment.
Design, debug & build mobile apps & 2D/3D high-impact games for multiple OSs.
http://pubads.g.doubleclick.net/gampad/clk?id=254741911&iu=/4140
_______________________________________________
Doxygen-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
