diff mbox series

[pacman-dev,18/23] doc: configure doxygen

Message ID 20201207221956.667322-19-morganamilo@archlinux.org
State Accepted, archived
Headers show
Series Docs Docs Docs 2: electric boogaloo | expand

Commit Message

morganamilo Dec. 7, 2020, 10:19 p.m. UTC 
- only document public alpm items (alpm_*)
- hide typedef'd structs (_alpm_pkg_t shows as alpm_pkg_t)
- enable inline struct definitions (this stops having a man page for
  every single struct)
---
 doc/Doxyfile.in | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 78481dd5..e2101a28 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -53,7 +53,7 @@  DISTRIBUTE_GROUP_DOC   = NO
 SUBGROUPING            = YES
 INLINE_GROUPED_CLASSES = NO
 INLINE_SIMPLE_STRUCTS  = NO
-TYPEDEF_HIDES_STRUCT   = NO
+TYPEDEF_HIDES_STRUCT   = YES
 SYMBOL_CACHE_SIZE      = 0
 LOOKUP_CACHE_SIZE      = 0
 #---------------------------------------------------------------------------
@@ -107,14 +107,14 @@  WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ../lib/libalpm/
+INPUT                  = ../lib/libalpm/alpm.h ../lib/libalpm/alpm_list.h
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          =
 RECURSIVE              = NO
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
-EXCLUDE_SYMBOLS        =
+EXCLUDE_SYMBOLS        = _alpm_* __alpm_*
 EXAMPLE_PATH           =
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO