Estimated read time: 1 minutes
There was a thread about this topic already, but just refusing to commit new files without documentation sounded too aggressive. So the current code just prints a warning.
It was also requested to show some good/bad examples. Lubos volunteered to add detailed instructions in the wiki, so I’m just describing in short what did I test so far.
A good example:
/// Handles export of foos using RTF markup class RtfFoo { };
A bad example:
class RtfBarBuggy { };
Example output when a warning is emitted:
~/git/libreoffice/master/sw$ git commit -a -m foo
sw/source/filter/ww8/bar.hxx:30: warning: Compound RtfBarBuggy is not documented.
[master 1b11571] foo
3 files changed, 68 insertions(+), 0 deletions(-)
create mode 100644 sw/source/filter/ww8/bar.hxx
create mode 100644 sw/source/filter/ww8/foo.hxx