From: Alexander Stein <alexander.stein@mailbox.org>
To: linux-gpio@vger.kernel.org
Cc: Alexander Stein <alexander.stein@mailbox.org>
Subject: [libgpiod] [PATCH 5/5] doc: Add @file to headers
Date: Sat, 8 Aug 2020 11:59:44 +0200 [thread overview]
Message-ID: <20200808095944.188479-6-alexander.stein@mailbox.org> (raw)
In-Reply-To: <20200808095944.188479-1-alexander.stein@mailbox.org>
This is necessary to have a file reference linked in the file list.
Also strip the top_srcdir from paths
Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
---
Doxyfile.in | 2 +-
bindings/cxx/gpiod.hpp | 4 ++++
include/gpiod.h | 4 ++++
3 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/Doxyfile.in b/Doxyfile.in
index 4abad2d..be2d250 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -22,7 +22,7 @@ BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ALWAYS_DETAILED_SEC = NO
FULL_PATH_NAMES = NO
-STRIP_FROM_PATH =
+STRIP_FROM_PATH = @top_srcdir@
INTERNAL_DOCS = NO
STRIP_CODE_COMMENTS = YES
CASE_SENSE_NAMES = YES
diff --git a/bindings/cxx/gpiod.hpp b/bindings/cxx/gpiod.hpp
index 59719aa..8dfc172 100644
--- a/bindings/cxx/gpiod.hpp
+++ b/bindings/cxx/gpiod.hpp
@@ -23,6 +23,10 @@ class line_iter;
class chip_iter;
struct line_event;
+/**
+ * @file gpiod.hpp
+ */
+
/**
* @defgroup gpiod_cxx C++ bindings
* @{
diff --git a/include/gpiod.h b/include/gpiod.h
index 58de66f..d1f9830 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -16,6 +16,10 @@
extern "C" {
#endif
+/**
+ * @file gpiod.h
+ */
+
/**
* @mainpage libgpiod public API
*
--
2.28.0
next prev parent reply other threads:[~2020-08-08 10:06 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-08 9:59 [libgpiod] [PATCH 0/5] Documentation improvements Alexander Stein
2020-08-08 9:59 ` [libgpiod] [PATCH 1/5] doc: Fix doxygen warnings Alexander Stein
2020-08-08 9:59 ` [libgpiod] [PATCH 2/5] doc: Use autotoolized Doxyfile Alexander Stein
2020-08-13 18:39 ` Bartosz Golaszewski
2020-08-08 9:59 ` [libgpiod] [PATCH 3/5] doc: Fix doxygen warning Alexander Stein
2020-08-08 9:59 ` [libgpiod] [PATCH 4/5] doc: Remove obsolete PERL_PATH Alexander Stein
2020-08-08 9:59 ` Alexander Stein [this message]
2020-08-10 16:49 ` [libgpiod] [PATCH 0/5] Documentation improvements Bartosz Golaszewski
2020-08-11 1:39 ` Kent Gibson
2020-08-11 18:24 ` Alexander Stein
2020-08-11 18:59 ` 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=20200808095944.188479-6-alexander.stein@mailbox.org \
--to=alexander.stein@mailbox.org \
--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).