[PATCH] Fix a missing doxygen section trailer in nlmsg.c

[PATCH] Fix a missing doxygen section trailer in nlmsg.c

[Duncan Roe]

This corrects an oddity in the web doco (and presumably in the man pages as
well) whereby "Netlink message batch helpers" was showing up as a sub-topic of
"Netlink message helpers".

This was included in my original (rejected) patch "Enable doxygen to generate
Function Documentation" with a comment "(didn't think it warrantied an extra
patch)" - clearly wrong
---
 src/nlmsg.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/nlmsg.c b/src/nlmsg.c
index fb99135..d398e63 100644
--- a/src/nlmsg.c
+++ b/src/nlmsg.c
@@ -370,6 +370,10 @@ EXPORT_SYMBOL void mnl_nlmsg_fprintf(FILE *fd, const void *data, size_t datalen,
 	}
 }
 
+/**
+ * @}
+ */
+
 /**
  * \defgroup batch Netlink message batch helpers
  *
-- 
2.14.5

Re: [PATCH] Fix a missing doxygen section trailer in nlmsg.c

[Duncan Roe]

On Wed, Oct 02, 2019 at 04:48:48PM +1000, Duncan Roe wrote:
> This corrects an oddity in the web doco (and presumably in the man pages as
> well) whereby "Netlink message batch helpers" was showing up as a sub-topic of
> "Netlink message helpers".
>
> This was included in my original (rejected) patch "Enable doxygen to generate
> Function Documentation" with a comment "(didn't think it warrantied an extra
> patch)" - clearly wrong
> ---
>  src/nlmsg.c | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/src/nlmsg.c b/src/nlmsg.c
> index fb99135..d398e63 100644
> --- a/src/nlmsg.c
> +++ b/src/nlmsg.c
> @@ -370,6 +370,10 @@ EXPORT_SYMBOL void mnl_nlmsg_fprintf(FILE *fd, const void *data, size_t datalen,
>  	}
>  }
>
> +/**
> + * @}
> + */
> +
>  /**
>   * \defgroup batch Netlink message batch helpers
>   *
> --
> 2.14.5
>
Sorry, should have mentioned: this patch is for libmnl

Cheers ... Duncan.

Re: [PATCH] Fix a missing doxygen section trailer in nlmsg.c

[Pablo Neira Ayuso]

On Thu, Oct 03, 2019 at 09:56:34AM +1000, Duncan Roe wrote:
> On Wed, Oct 02, 2019 at 04:48:48PM +1000, Duncan Roe wrote:
> > This corrects an oddity in the web doco (and presumably in the man pages as
> > well) whereby "Netlink message batch helpers" was showing up as a sub-topic of
> > "Netlink message helpers".

Applied, thanks.