All of lore.kernel.org
 help / color / mirror / Atom feed
From: Erik Schilling <erik.schilling@linaro.org>
To: Linux-GPIO <linux-gpio@vger.kernel.org>
Cc: Bartosz Golaszewski <brgl@bgdev.pl>,
	Viresh Kumar <viresh.kumar@linaro.org>,
	Erik Schilling <erik.schilling@linaro.org>
Subject: [libgpiod][PATCH 1/3] doc: drop unneeded <p> tags
Date: Thu, 28 Sep 2023 16:37:28 +0200	[thread overview]
Message-ID: <20230928-rust-send-trait-v1-1-30b4f59d13cb@linaro.org> (raw)
In-Reply-To: <20230928-rust-send-trait-v1-0-30b4f59d13cb@linaro.org>

Even before Doxygen gained Markdown support, empty lines were considered
as paragraphs. Changelogs indicate that this was the case since at least
the doxygen 1.2 series (where I found a mentiond that something around
this behaviour was fixed). So at least works in Doxygen versions
released after 2001 [1].

[1] https://sourceforge.net/p/doxygen/mailman/message/172899/

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
---
 include/gpiod.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/gpiod.h b/include/gpiod.h
index 71ae798..be51c3a 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -22,11 +22,11 @@ extern "C" {
  * This is the complete documentation of the public API made available to
  * users of libgpiod.
  *
- * <p>The API is logically split into several sections. For each opaque data
+ * The API is logically split into several sections. For each opaque data
  * class, there's a set of functions for manipulating it. Together they can be
  * thought of as objects and their methods in OOP parlance.
  *
- * <p>General note on error handling: all functions exported by libgpiod that
+ * General note on error handling: all functions exported by libgpiod that
  * can fail, set errno to one of the error values defined in errno.h upon
  * failure. The way of notifying the caller that an error occurred varies
  * between functions, but in general a function that returns an int, returns -1
@@ -35,7 +35,7 @@ extern "C" {
  * codes for every function as they propagate errors from the underlying libc
  * functions.
  *
- * <p>In general libgpiod functions are NULL-aware. For functions that are
+ * In general libgpiod functions are NULL-aware. For functions that are
  * logically methods of data classes - ones that take a pointer to the object
  * of that class as the first argument - passing a NULL pointer will result in
  * the program aborting the execution. For non-methods, init functions and

-- 
2.41.0


  reply	other threads:[~2023-09-28 14:37 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-28 14:37 [libgpiod][PATCH 0/3] thread-safety doc + Rust modeling Erik Schilling
2023-09-28 14:37 ` Erik Schilling [this message]
2023-09-28 14:37 ` [libgpiod][PATCH 2/3] doc: document thread safety guarantees Erik Schilling
2023-09-28 14:37 ` [libgpiod][PATCH 3/3] bindings: rust: mark all owning types as `Send` Erik Schilling
2023-09-29 10:58   ` Viresh Kumar
2023-09-29 12:45     ` Bartosz Golaszewski
2023-09-29 12:47       ` Erik Schilling
2023-09-29 13:07         ` Bartosz Golaszewski
2023-10-02  7:16 ` [libgpiod][PATCH 0/3] thread-safety doc + Rust modeling Bartosz Golaszewski
2023-10-02  7:22   ` Erik Schilling

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=20230928-rust-send-trait-v1-1-30b4f59d13cb@linaro.org \
    --to=erik.schilling@linaro.org \
    --cc=brgl@bgdev.pl \
    --cc=linux-gpio@vger.kernel.org \
    --cc=viresh.kumar@linaro.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.