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: add doc for opaque structs to link to the relevant page
Date: Fri,  9 Jun 2023 15:39:57 +0800	[thread overview]
Message-ID: <20230609073957.72418-1-warthog618@gmail.com> (raw)

The C doxygen documentation is difficult to navigate as the opaque types
do not get linked to anything.

Add doc for each opaque struct that references the relevant page.

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

There might be a better way to do this, but this the best I've run
across so far.  At least the generated doc is navigable without having to
return to the modules page and perform mental gymnastics.

Along the way, also renamed the request_request group to line_request as
that makes more sense.

Haven't pushed this one to rtd yet, as this is a more significant
change - not just fixing a typo.

Cheers,
Kent.

 include/gpiod.h | 66 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 65 insertions(+), 1 deletion(-)

diff --git a/include/gpiod.h b/include/gpiod.h
index d1833de..d459151 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -44,15 +44,79 @@ extern "C" {
  * handling it, ignoring it or returning an error.
  */
 
+/**
+ * @struct gpiod_chip
+ * @{
+ *  Refer to @ref chips for functions that operate on gpiod_chip.
+ * @}
+*/
 struct gpiod_chip;
+/**
+ * @struct gpiod_chip_info
+ * @{
+ *  Refer to @ref chip_info for functions that operate on gpiod_chip_info.
+ * @}
+*/
 struct gpiod_chip_info;
+/**
+ * @struct gpiod_line_info
+ * @{
+ *  Refer to @ref line_info for functions that operate on gpiod_line_info.
+ * @}
+*/
 struct gpiod_line_info;
+/**
+ * @struct gpiod_line_settings
+ * @{
+ *  Refer to @ref line_settings for functions that operate on
+ *  gpiod_line_settings.
+ * @}
+*/
 struct gpiod_line_settings;
+/**
+ * @struct gpiod_line_config
+ * @{
+ *  Refer to  @ref line_config for functions that operate on gpiod_line_config.
+ * @}
+*/
 struct gpiod_line_config;
+/**
+ * @struct gpiod_request_config
+ * @{
+ *  Refer to  @ref request_config for functions that operate on
+ *  gpiod_request_config.
+ * @}
+*/
 struct gpiod_request_config;
+/**
+ * @struct gpiod_line_request
+ * @{
+ *  Refer to  @ref line_request for functions that operate on
+ *  gpiod_line_request.
+ * @}
+*/
 struct gpiod_line_request;
+/**
+ * @struct gpiod_info_event
+ * @{
+ *  Refer to  @ref line_watch for functions that operate on gpiod_info_event.
+ * @}
+*/
 struct gpiod_info_event;
+/**
+ * @struct gpiod_edge_event
+ * @{
+ *  Refer to  @ref edge_event for functions that operate on gpiod_edge_event.
+ * @}
+*/
 struct gpiod_edge_event;
+/**
+ * @struct gpiod_edge_event_buffer
+ * @{
+ *  Refer to  @ref edge_event for functions that operate on
+ *  gpiod_edge_event_buffer.
+ * @}
+*/
 struct gpiod_edge_event_buffer;
 
 /**
@@ -902,7 +966,7 @@ gpiod_request_config_get_event_buffer_size(struct gpiod_request_config *config);
 /**
  * @}
  *
- * @defgroup request_request Line request operations
+ * @defgroup line_request Line request operations
  * @{
  *
  * Functions allowing interactions with requested lines.
-- 
2.40.1


             reply	other threads:[~2023-06-09  7:40 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-09  7:39 Kent Gibson [this message]
2023-06-09 20:17 ` [libgpiod][PATCH] core: doc: add doc for opaque structs to link to the relevant page Bartosz Golaszewski
2023-06-10  0:27   ` Kent Gibson

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=20230609073957.72418-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).