[libgpiod,5/5] doc: Add @file to headers

Message ID 20200808095944.188479-6-alexander.stein@mailbox.org
State New
Headers show
Series
  • Untitled series #50951
Related show

Commit Message

Alexander Stein Aug. 8, 2020, 9:59 a.m.
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(-)

Patch

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
  *