[LTP] [PATCH 3/4] include: Fix kernel-doc warnings in header comments

[Andrea Cervesato]

Hi Cyril,

> Hi!
> > > Downgrade kernel-doc comments to plain comments for struct tst_cmd
> > > and TST_CAP() macro to avoid name collisions with the tst_cmd()
> > > function and struct tst_cap respectively. The kernel-doc parser
> > > flattens names case-insensitively, causing 'name used several times'
> > > errors and duplicate target warnings.
> > 
> > Hm ...
> > 
> > ...
> > > +++ b/include/tst_capability.h
> > > @@ -67,7 +67,7 @@ struct tst_cap {
> > >  	char *name;
> > >  };
> > 
> > > -/**
> > > +/*
> > >   * TST_CAP() - Create a struct tst_cap entry.
> > 
> > This is the only warning I'd prefer to stay unfixed (i.e. it was kept in the
> > docs). I wonder if we shouldn't jus rename struct or macro. Because TST_CAP()
> > should be documented. Cyril @WDYT?
> 
> Looking at the resulting html pages both the structure and the function
> is documented properly there. Also as long as we use c:func: and c:type:
> in referencies everything should work. So I vote for ignoring this as
> well.
> 
> -- 
> Cyril Hrubis
> chrubis@suse.cz

Ok so I will just ignore it as it was in the beginning and merge
the patch-set.

Regards,
--
Andrea Cervesato
SUSE QE Automation Engineer Linux
andrea.cervesato@suse.com