From 0adedc536fe372b4def5954f3b24ca63ff86aecf Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sun, 14 Oct 2007 17:29:32 -0500 Subject: Updates to fix Doxygen documentation generation We had way too much going on with the Doxygen manpage generation. Clean it up quite a bit by removing directory manpages, using relative paths, not having a manpage for every single alpm function, and ensuring internal functions are not documented publicly. Signed-off-by: Dan McGee --- doc/Doxyfile | 6 +++--- doc/Makefile.am | 2 +- lib/libalpm/alpm.h | 4 ++-- lib/libalpm/alpm_list.h | 6 ++---- lib/libalpm/md5.h | 6 +++--- 5 files changed, 11 insertions(+), 13 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 0d20274b..e4527906 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -24,7 +24,7 @@ ABBREVIATE_BRIEF = "The $name class" \ the ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO STRIP_FROM_PATH = STRIP_FROM_INC_PATH = SHORT_NAMES = NO @@ -68,7 +68,7 @@ GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES -SHOW_DIRECTORIES = YES +SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages @@ -165,7 +165,7 @@ RTF_EXTENSIONS_FILE = GENERATE_MAN = YES MAN_OUTPUT = . MAN_EXTENSION = .3 -MAN_LINKS = YES +MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- diff --git a/doc/Makefile.am b/doc/Makefile.am index d3c168d6..51b3e280 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -42,7 +42,7 @@ if USE_DOXYGEN all: doxygen.in doxygen.in: - doxygen $(srcdir)/Doxyfile + $(DOXYGEN) $(srcdir)/Doxyfile endif if USE_ASCIIDOC diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index b90ab896..6eda2106 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -31,6 +31,8 @@ extern "C" { #include /* for time_t */ #include /* for va_list */ +#include + #define DEPRECATED __attribute__((deprecated)) /* @@ -41,8 +43,6 @@ extern "C" { * Structures */ -typedef struct __alpm_list_t alpm_list_t; - typedef struct __pmdb_t pmdb_t; typedef struct __pmpkg_t pmpkg_t; typedef struct __pmgrp_t pmgrp_t; diff --git a/lib/libalpm/alpm_list.h b/lib/libalpm/alpm_list.h index 10d01df2..a2a06f4c 100644 --- a/lib/libalpm/alpm_list.h +++ b/lib/libalpm/alpm_list.h @@ -25,8 +25,6 @@ extern "C" { #endif -#include "alpm.h" - /** * @brief Linked list type used by libalpm. * @@ -34,14 +32,14 @@ extern "C" { * lists of their own; however, it is not required that the front end uses * it. */ -struct __alpm_list_t { +typedef struct __alpm_list_t { /** data held by the list node */ void *data; /** pointer to the previous node */ struct __alpm_list_t *prev; /** pointer to the next node */ struct __alpm_list_t *next; -}; +} alpm_list_t; #define FREELIST(p) do { alpm_list_free_inner(p, free); alpm_list_free(p); p = NULL; } while(0) diff --git a/lib/libalpm/md5.h b/lib/libalpm/md5.h index 4adc8a88..08dad1ec 100644 --- a/lib/libalpm/md5.h +++ b/lib/libalpm/md5.h @@ -18,9 +18,6 @@ * MA 02110-1301 USA */ -/** - * \file md5.h - */ #ifndef _MD5_H #define _MD5_H @@ -29,6 +26,7 @@ extern "C" { #endif /** + * \internal * \brief MD5 context structure */ typedef struct @@ -40,6 +38,7 @@ typedef struct md5_context; /** + * \internal * \brief Output = MD5( input buffer ) * * \param input buffer holding the data @@ -50,6 +49,7 @@ void md5( unsigned char *input, int ilen, unsigned char *output ); /** + * \internal * \brief Output = MD5( file contents ) * * \param path input file name -- cgit v1.2.3-70-g09d2