diff mbox series

[libgpiod] Fix documentation for newer Doxygen versions

Message ID 20200421194314.1305802-1-qsx@chaotikum.eu
State New
Headers show
Series [libgpiod] Fix documentation for newer Doxygen versions | expand

Commit Message

Thomas Schneider April 21, 2020, 7:43 p.m. UTC
- The various groups used to be named __some_thing__, which was turned into
  <strong>…</strong>.  A later stage of Doxygen barfed on that, and thus it
  generated some warnings, and all documentation was in a group called “strong”.
- The PERL_PATH config item has been deprecated.  Remove it.

Signed-off-by: Thomas Schneider <qsx@chaotikum.eu>
---
 Doxyfile               |  1 -
 bindings/cxx/gpiod.hpp |  2 +-
 include/gpiod.h        | 26 +++++++++++++-------------
 3 files changed, 14 insertions(+), 15 deletions(-)

Comments

Bartosz Golaszewski May 12, 2020, 4:34 p.m. UTC | #1
wt., 21 kwi 2020 o 22:03 Thomas Schneider <qsx@chaotikum.eu> napisał(a):
>
> - The various groups used to be named __some_thing__, which was turned into
>   <strong>…</strong>.  A later stage of Doxygen barfed on that, and thus it
>   generated some warnings, and all documentation was in a group called “strong”.
> - The PERL_PATH config item has been deprecated.  Remove it.
>

Hi Thomas,

Thanks for the patch. Could you please split these changes into two
separate patches? Also: could you rebase on top of current master,
because this doesn't apply cleanly.

Bart
diff mbox series

Patch

diff --git a/Doxyfile b/Doxyfile
index b194095..d72a334 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -106,4 +106,3 @@  GENERATE_XML           = YES
 TAGFILES               =
 GENERATE_TAGFILE       =
 ALLEXTERNALS           = NO
-PERL_PATH              =
diff --git a/bindings/cxx/gpiod.hpp b/bindings/cxx/gpiod.hpp
index 07f465f..3238e4c 100644
--- a/bindings/cxx/gpiod.hpp
+++ b/bindings/cxx/gpiod.hpp
@@ -24,7 +24,7 @@  class line_iter;
 class chip_iter;
 
 /**
- * @defgroup __gpiod_cxx__ C++ bindings
+ * @defgroup gpiod_cxx C++ bindings
  * @{
  */
 
diff --git a/include/gpiod.h b/include/gpiod.h
index 9820362..a03f44a 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -46,7 +46,7 @@  struct gpiod_line_iter;
 struct gpiod_line_bulk;
 
 /**
- * @defgroup __common__ Common helper macros
+ * @defgroup common Common helper macros
  * @{
  *
  * Commonly used utility macros.
@@ -77,7 +77,7 @@  struct gpiod_line_bulk;
 /**
  * @}
  *
- * @defgroup __high_level__ High-level API
+ * @defgroup high_level High-level API
  * @{
  *
  * Simple high-level routines for straightforward GPIO manipulation without
@@ -539,7 +539,7 @@  int gpiod_ctxless_find_line(const char *name, char *chipname,
 /**
  * @}
  *
- * @defgroup __chips__ GPIO chip operations
+ * @defgroup chips GPIO chip operations
  * @{
  *
  * Functions and data structures dealing with GPIO chips.
@@ -676,12 +676,12 @@  int gpiod_chip_find_lines(struct gpiod_chip *chip, const char **names,
 /**
  * @}
  *
- * @defgroup __lines__ GPIO line operations
+ * @defgroup lines GPIO line operations
  * @{
  *
  * Functions and data structures dealing with GPIO lines.
  *
- * @defgroup __line_bulk__ Operating on multiple lines
+ * @defgroup line_bulk Operating on multiple lines
  * @{
  *
  * Convenience data structures and helper functions for storing and operating
@@ -792,7 +792,7 @@  gpiod_line_bulk_num_lines(struct gpiod_line_bulk *bulk)
 /**
  * @}
  *
- * @defgroup __line_info__ Line info
+ * @defgroup line_info Line info
  * @{
  *
  * Definitions and functions for retrieving kernel information about both
@@ -938,7 +938,7 @@  gpiod_line_needs_update(struct gpiod_line *line) GPIOD_API GPIOD_DEPRECATED;
 /**
  * @}
  *
- * @defgroup __line_request__ Line requests
+ * @defgroup line_request Line requests
  * @{
  *
  * Interface for requesting GPIO lines from userspace for both values and
@@ -1266,7 +1266,7 @@  bool gpiod_line_is_free(struct gpiod_line *line) GPIOD_API;
 /**
  * @}
  *
- * @defgroup __line_value__ Reading & setting line values
+ * @defgroup line_value Reading & setting line values
  * @{
  *
  * Functions allowing to read and set GPIO line values for single lines and
@@ -1321,7 +1321,7 @@  int gpiod_line_set_value_bulk(struct gpiod_line_bulk *bulk,
 /**
  * @}
  *
- * @defgroup __line_config__ Setting line configuration
+ * @defgroup line_config Setting line configuration
  * @{
  *
  * Functions allowing modification of config options of GPIO lines requested
@@ -1437,7 +1437,7 @@  int gpiod_line_set_direction_output_bulk(struct gpiod_line_bulk *bulk,
 /**
  * @}
  *
- * @defgroup __line_event__ Line events handling
+ * @defgroup line_event Line events handling
  * @{
  *
  * Structures and functions allowing to poll lines for events and read them,
@@ -1551,7 +1551,7 @@  int gpiod_line_event_read_fd_multiple(int fd, struct gpiod_line_event *events,
 /**
  * @}
  *
- * @defgroup __line_misc__ Misc line functions
+ * @defgroup line_misc Misc line functions
  * @{
  *
  * Functions that didn't fit anywhere else.
@@ -1604,7 +1604,7 @@  struct gpiod_chip *gpiod_line_get_chip(struct gpiod_line *line) GPIOD_API;
  *
  * @}
  *
- * @defgroup __iterators__ Iterators for GPIO chips and lines
+ * @defgroup iterators Iterators for GPIO chips and lines
  * @{
  *
  * These functions and data structures allow easy iterating over GPIO
@@ -1728,7 +1728,7 @@  gpiod_line_iter_next(struct gpiod_line_iter *iter) GPIOD_API;
 /**
  * @}
  *
- * @defgroup __misc__ Stuff that didn't fit anywhere else
+ * @defgroup misc Stuff that didn't fit anywhere else
  * @{
  *
  * Various libgpiod-related functions.