Netfilter-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Duncan Roe <duncan_roe@optusnet.com.au>
To: Pablo Neira Ayuso <pablo@netfilter.org>
Cc: Netfilter Development <netfilter-devel@vger.kernel.org>
Subject: Re: [PATCH] src: Enable doxygen to generate Function Documentation
Date: Sat, 14 Sep 2019 13:25:56 +1000
Message-ID: <20190914032556.GA14997@dimstar.local.net> (raw)
In-Reply-To: <20190908082505.3320-1-duncan_roe@optusnet.com.au>

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@optusnet.com.au>
> ---
>  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.

      reply index

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-08  8:25 Duncan Roe
2019-09-14  3:25 ` Duncan Roe [this message]

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190914032556.GA14997@dimstar.local.net \
    --to=duncan_roe@optusnet.com.au \
    --cc=netfilter-devel@vger.kernel.org \
    --cc=pablo@netfilter.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Netfilter-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/netfilter-devel/0 netfilter-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 netfilter-devel netfilter-devel/ https://lore.kernel.org/netfilter-devel \
		netfilter-devel@vger.kernel.org netfilter-devel@archiver.kernel.org
	public-inbox-index netfilter-devel


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.netfilter-devel


AGPL code for this site: git clone https://public-inbox.org/ public-inbox