From 26faaa67c1a06f3e6cd78192ae12f0499633f8f6 Mon Sep 17 00:00:00 2001 From: Willem Toorop Date: Wed, 21 May 2014 16:21:45 +0200 Subject: [PATCH] Fix building docs for blddir != srcdir --- doc/getdns_list_get.3.in | 2 +- src/Doxyfile.in | 11 ++++++----- src/context.c | 3 ++- src/dict.c | 5 +++-- src/getdns/getdns.h.in | 4 ++-- 5 files changed, 14 insertions(+), 11 deletions(-) diff --git a/doc/getdns_list_get.3.in b/doc/getdns_list_get.3.in index 95689c72..aef83e19 100644 --- a/doc/getdns_list_get.3.in +++ b/doc/getdns_list_get.3.in @@ -28,7 +28,7 @@ .TH getdns_list 3 "@date@" "getdns @version@" getdns .SH NAME -.B getdns_list, +.B getdns_list_get, .B getdns_list_get_bindata, .B getdns_list_get_data_type, .B getdns_list_get_dict, diff --git a/src/Doxyfile.in b/src/Doxyfile.in index 9696e18e..00fb0e26 100644 --- a/src/Doxyfile.in +++ b/src/Doxyfile.in @@ -692,11 +692,12 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = . \ - getdns/ \ - example/ \ - test/ \ - ../README.md +INPUT = @srcdir@ \ + getdns/ \ + @srcdir@/getdns/ \ + @srcdir@/example/ \ + @srcdir@/test/ \ + @srcdir@/../README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/src/context.c b/src/context.c index 9a7f68a8..9c01e269 100644 --- a/src/context.c +++ b/src/context.c @@ -168,7 +168,8 @@ add_ip_str(struct getdns_dict * ip) /** * check a file for changes since the last check * and refresh the current data if changes are detected - * @param file to check + * @param context pointer to a previously created context to be used for this call + * @param fchg file to check * @returns changes as OR'd list of GETDNS_FCHG_* values * @returns GETDNS_FCHG_NONE if no changes * @returns GETDNS_FCHG_ERRORS if problems (see fchg->errors for details) diff --git a/src/dict.c b/src/dict.c index a69bbdcd..e12be52c 100644 --- a/src/dict.c +++ b/src/dict.c @@ -47,7 +47,6 @@ * private function used to locate a key in a dictionary * @param dict dicitonary to search * @param key key to search for - * @param addifnotfnd if TRUE then an item will be added if the key is not found * @return pointer to dictionary item, caller must not free storage associated with item * @return NULL if additnotfnd == FALSE and key is not in dictionary */ @@ -342,7 +341,9 @@ getdns_dict_copy(const struct getdns_dict * srcdict, /*---------------------------------------- getdns_dict_item_free */ /** * private function used to release storage associated with a dictionary item - * @param item all memory in this structure and its children will be freed + * @param node all memory in this structure and its children will be freed + * @param arg is a dict who's custom memory function will be used + * to free the items * @return void */ void diff --git a/src/getdns/getdns.h.in b/src/getdns/getdns.h.in index fed905a4..955c7ddf 100644 --- a/src/getdns/getdns.h.in +++ b/src/getdns/getdns.h.in @@ -656,7 +656,7 @@ void getdns_list_destroy(getdns_list *this_list); * the child dict and will free the copy when the list is destroyed * @param this_list list containing the item to which child_list is to be assigned * @param index index of the item within list to which child_list is to be assigned - * @param *child_list list to assign to the item + * @param *child_dict dict to assign to the item * @return GETDNS_RETURN_GOOD on success * @return GETDNS_RETURN_NO_SUCH_LIST_ITEM if index is out of range, or list is NULL */ @@ -915,7 +915,7 @@ getdns_validate_dnssec(getdns_list *to_validate, * creates a string that describes the dictionary in a human readable form * one line per item in the dictionary * TODO: maybe this should be json or something machine readable too - * @param this_dict dictionary to pretty print + * @param some_dict dictionary to pretty print * @return character array (caller must free this) containing pretty string */ char *getdns_pretty_print_dict(const getdns_dict *some_dict);