Re: [PATCH] src: Enable doxygen to generate Function Documentation

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

 



Hi Pablo,

On Fri, Sep 20, 2019 at 11:05:09AM +0200, Pablo Neira Ayuso wrote:
> On Fri, Sep 20, 2019 at 10:00:06AM +1000, Duncan Roe wrote:
> > (cc'ing list - already sent to Pablo)
> >
> > Hi Pablo,
> >
> > On Sat, Sep 14, 2019 at 01:25:56PM +1000, Duncan Roe wrote:
> > > Hi Pablo,
> > >
> > > On Sun, Sep 08, 2019 at 06:25:05PM +1000, Duncan Roe wrote:
> > > > The C source files all contain doxygen documentation for each defined function
> > > > but this was not appearing in the generated HTML.
> > > > Fix is to move all EXPORT_SYMBOL macro calls to after the function definition.
> > > > Doxygen seems to otherwise forget the documentation on encountering
> > > > EXPORT_SYMBOL which is flagged in the EXCLUDE_SYMBOLS tag in doxygen.cfg.in.
> > > > I encountered this "feature" in doxygen 1.8.9.1 but it still appears to be
> > > > present in 1.8.16
> > > >
> > > > Signed-off-by: Duncan Roe <duncan_roe@xxxxxxxxxxxxxxx>
> > > > ---
> > > >  src/attr.c     | 70 +++++++++++++++++++++++++++++-----------------------------
> > > >  src/callback.c |  4 ++--
> > > >  src/nlmsg.c    | 40 ++++++++++++++++-----------------
> > > >  src/socket.c   | 22 +++++++++---------
> > > >  4 files changed, 68 insertions(+), 68 deletions(-)
> > > >
> > > > diff --git a/src/attr.c b/src/attr.c
> > > > index 0359ba9..ca42d3e 100644
> > > > --- a/src/attr.c
> > > > +++ b/src/attr.c
> > > > @@ -35,11 +35,11 @@
> > > >   *
> > > >   * This function returns the attribute type.
> > > >   */
> > > > -EXPORT_SYMBOL(mnl_attr_get_type);
> > > >  uint16_t mnl_attr_get_type(const struct nlattr *attr)
> > > >  {
> > > >  	return attr->nla_type & NLA_TYPE_MASK;
> > > >  }
> > > > +EXPORT_SYMBOL(mnl_attr_get_type);
> > > >
> > > [...]
> > >
> > > Oops! I forgot to say: this is a patch for libmnl.
> > >
> > > Cheers ... Duncan.
> >
> > Any feedback re this patch?
>
> Your patch breaks clang compilation, we need to find a different
> solution for this bug.
>
> Thank you.

I submitted a v3 (v2 lost its commit message somehow)

libnetfilter_queue fails with clang as_is - will send a patch.

Cheers ... Duncan.



[Index of Archives]     [Netfitler Users]     [Berkeley Packet Filter]     [LARTC]     [Bugtraq]     [Yosemite Forum]

  Powered by Linux