doc: document static inline functions

Configure doxygen to document static inline functions from gpiod.h
as well. While we're at it: add a PREDEFINED option to mark functions
in the header that are not part of the API.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

diff --git a/Doxyfile b/Doxyfile
index 322d39d4c2a1f9f8ec2a88b9ec45928483060135..ec7f7d99b69bfd7d5bd106a2d8f85bc27a05dc80 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -14,7 +14,7 @@ OUTPUT_DIRECTORY       = doc
 OUTPUT_LANGUAGE        = English
 EXTRACT_ALL            = NO
 EXTRACT_PRIVATE        = NO
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 HIDE_UNDOC_MEMBERS     = NO
 HIDE_UNDOC_CLASSES     = NO
 BRIEF_MEMBER_DESC      = YES
@@ -57,6 +57,8 @@ ALPHABETICAL_INDEX     = NO
 COLS_IN_ALPHA_INDEX    = 5
 IGNORE_PREFIX          =
 SEARCHENGINE           = NO
+ENABLE_PREPROCESSING   = YES
+PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
 
 # HTML output
 GENERATE_HTML          = YES

diff --git a/include/gpiod.h b/include/gpiod.h
index 132f979c5160b37fe80d47e32f4db5dd68bfe89d..efd5d4c4e3f96014d33687502ef6c7a57e71e38d 100644 (file)
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -635,6 +635,7 @@ struct gpiod_line_event {
 int gpiod_line_event_request(struct gpiod_line *line,
                             struct gpiod_line_evreq_config *config) GPIOD_API;
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 static inline int _gpiod_line_event_request_type(struct gpiod_line *line,
                                                 const char *consumer,
                                                 bool active_low,
@@ -649,6 +650,7 @@ static inline int _gpiod_line_event_request_type(struct gpiod_line *line,
 
        return gpiod_line_event_request(line, &config);
 }
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 /**
  * @brief Request rising edge event notifications on a single line.