linux-gpio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kent Gibson <warthog618@gmail.com>
To: linux-gpio@vger.kernel.org, brgl@bgdev.pl
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [libgpiod][PATCH] core: doc: fix line_config documentation generation
Date: Fri,  9 Jun 2023 12:07:37 +0800	[thread overview]
Message-ID: <20230609040737.25666-1-warthog618@gmail.com> (raw)

The line configuration is missing from the generated documentation as the
comment for the defgroup is a normal comment, not a doc comment.

Add the asterisk to make the section a doc comment.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
---

I took the liberty of patching and updating the rtd documentation, so it
is already fixed there.

It would be nice if the generated documentation would provide links from
the "struct gpiod_line_config" to the corresponding page.  But not sure
how to do that, or if it is even possible.

Cheers,
Kent.

 include/gpiod.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/gpiod.h b/include/gpiod.h
index d1833de..5d4b6af 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -715,7 +715,7 @@ int gpiod_line_settings_set_output_value(struct gpiod_line_settings *settings,
 enum gpiod_line_value
 gpiod_line_settings_get_output_value(struct gpiod_line_settings *settings);
 
-/*
+/**
  * @}
  *
  * @defgroup line_config Line configuration objects
-- 
2.40.1


             reply	other threads:[~2023-06-09  4:07 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-09  4:07 Kent Gibson [this message]
2023-06-09  7:38 ` [libgpiod][PATCH] core: doc: fix line_config documentation generation Bartosz Golaszewski

Reply instructions:

You may reply publicly 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=20230609040737.25666-1-warthog618@gmail.com \
    --to=warthog618@gmail.com \
    --cc=brgl@bgdev.pl \
    --cc=linux-gpio@vger.kernel.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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).