[PATCHES] Doxygen for smbtorture

Christof Schmitt cs at samba.org
Thu Oct 8 19:08:56 UTC 2015


On Thu, Oct 08, 2015 at 08:06:02AM +0200, Volker Lendecke wrote:
> On Wed, Oct 07, 2015 at 11:26:30AM -0700, Christof Schmitt wrote:
> > The only documentation for smbtorture is the actual source code. These
> > patches start adding doxygen comments to make browsing the testcases a
> > bit easier. This is mostly an example to find out whether others would
> > also find this useful. If yes, i can (time permitting) add more doxygen
> > comments to the other testcases.
> 
> Good stuff! Like with all documentation, we need to watch
> out that this stays up to date, but I know too well how
> difficult it can be to find out what a test is supposed to
> do.

True. Every change to a testcase also has to ensure that the
documentation is still accurate. I just discovered that doxygen can
group items together. That might give a better overview of the available
tests. Let me try this, and i will probably sent an updated patchset.

Christof



More information about the samba-technical mailing list