Commit Graph

44 Commits

Author SHA1 Message Date
Sara Dickinson d3309e89e8 Initial pass at updating Doxygen modules for getdns.h. Also add info on using context_create multithreaded.
- this is a rough first pass at making the oxygen Modules page more consistent and user navigable
  as a handy index into getdns
- I think a further re-org is needed in a later update, also haven't touched getdns_extra.h yet
- Added a few functions descriptions too, but still many functions without comments... a WIP
- Updated man page for context_create with multi-threaded instructions as a short term fix
2016-06-25 18:09:56 +01:00
Linus Nordberg f837e32204 Correct return value in documentation for getdns_pretty_print_dict(). 2016-02-05 15:47:26 +01:00
Sara Dickinson fc4e4f23df Rename return_call_debugging to return_call_reporting. Update index.html with change of content. 2015-12-16 14:20:35 +00:00
Daniel Kahn Gillmor 540ffb8a4a report manpage date based on the name of the API
This links the manual pages to the API "string version", and avoids
problems with reproducibility (the man pages should not get modified
simply because they are built in a different month, or because they
were built with a different locale).

Gbp-Pq: Name 0001-report-manpage-date-based-on-the-name-of-the-API.patch
2015-07-19 12:22:10 +02:00
Anthony Kirby 198e8baf69 docs: fix index param for getdns_list_set_xxx
the second parameter for these 4 functions is an index, not a name
(looks like cut'n'paste from getdns_dict_set_xxx)
2015-05-19 15:17:00 +01:00
Anthony Kirby 7c0268b42c docs: clarify how extensions are specified
The way that extensions are described in documentation can make it appear to a naive user that they are function names.  Quoting the strings makes it clearer that they are just strings.

(it's obvious in retrospect, but I needed to look at the source to get this)
2015-05-19 11:07:20 +01:00
Willem Toorop ca52a4abe5 One more "cannot adjust line" warning 2015-01-14 15:35:20 +01:00
Willem Toorop e9196f22d1 Manpages eliminate "cannot adjust line" warnings 2015-01-14 15:33:20 +01:00
Willem Toorop cdf0921ced Fix and add check for manpage-has-bad-whatis-entry
Also remove obsolete getdns_free_sync_request_memory function
Also list all authors in libgetdns manpage
2014-11-10 15:50:45 +01:00
Willem Toorop 46557a93dc Cannot mix 'man' and 'mdoc' macro's in manpages
+ small updates to text
- change "File Descriptor Polling" to "Build-in Event loop"
and removal of "Custom Event Loop Integrations" section from libgetdns.
2014-11-10 15:14:58 +01:00
Willem Toorop 9003f013a4 return_api_information extension doesn't exist
So remove from manpage
2014-09-03 15:46:17 +02:00
Willem Toorop 3b9c1270c2 [API 0.505] "resolver_type" now "resolution_type"
Renamed in the response from getdns_context_get_api_information()
2014-09-03 15:42:11 +02:00
Willem Toorop 67f953d24f make check in doc to show manpage errors 2014-06-13 10:58:52 +02:00
Willem Toorop 26faaa67c1 Fix building docs for blddir != srcdir 2014-05-21 16:21:45 +02:00
Willem Toorop 76dcab7850 Fix -I and -L flags to look into builddir too
And removal of looking into /usr/local/include and /usr/local/lib.
I hope this doesn't break anything...
2014-05-19 15:23:40 +02:00
Glen Wiley ba3b0bfaab added dict/list memory functions, api_information, cleaned up copyrights 2014-04-25 07:49:25 -04:00
Glen Wiley 65c0872ec1 added some context set functions to the man page 2014-04-24 10:53:08 -04:00
Glen Wiley f354ec786f added man pages for some helper functions 2014-04-24 10:13:19 -04:00
Glen Wiley 02d318a8ea added DNSSEC, OPT narratives, cleaned up language, alphabetized return codes 2014-03-10 18:19:28 -04:00
Glen Wiley 04096d6cfa added text in asynch section for the library overview 2014-03-06 14:41:12 -05:00
Glen Wiley e0e85b8b3e if doxygen is missing no longer fail make in doc dir 2014-03-06 12:14:19 -05:00
Glen Wiley 2ce7e81c51 improved per feedback from Dow 2014-03-04 03:47:56 -05:00
Willem Toorop d2c890ab6a Fill in <organization> place holder.
s/the name of the <organization>/the names of the copyright holders/g
2014-02-25 14:23:19 +01:00
Willem Toorop 8d77505219 s/Versign/Verisign/g in all files 2014-02-25 14:12:33 +01:00
Glen Wiley 6dd03b1cdc fixed spelling of NLnet in licenses, fixed make clean errs in docs 2014-02-24 09:26:20 -05:00
Glen Wiley 7dfcfc7beb man page updates to align with latest API changes and craigs feedback 2014-02-20 17:29:39 -05:00
Glen Wiley 344893f87f fixed license and copyright notices 2014-02-20 09:12:19 -05:00
Willem Toorop f009158a74 GETDNS_COMPILATION_COMMENT & include spec in dist 2014-02-20 14:07:04 +01:00
Glen Wiley dcb3037f1b more updates to man pages...even closer to being done 2014-02-19 18:18:52 -05:00
Glen Wiley 0f2ed2c35f man page changes and additions (getting closer to complete) 2014-02-19 17:30:01 -05:00
Glen Wiley bdff98ffb3 steps toward proper support of namespaces and system files 2014-02-10 19:59:45 -05:00
Glen Wiley 267530909b added context pages 2014-02-05 16:27:37 -05:00
Bryan Graham 6e296cea7f initial check_getdns_testcases.doc upload 2014-01-15 11:45:41 -05:00
Glen Wiley aed5047216 updates to man pages 2013-12-12 07:45:07 -05:00
W.C.A. Wijngaards 601b821c43 Edit date and version number into the manpages with sed. 2013-12-10 11:44:36 +01:00
W.C.A. Wijngaards b736e38886 Make and install new manpages. Easy list of manpages in Makefile.in. 2013-12-10 10:32:57 +01:00
Glen Wiley 668e493d9b added text to man pages - still need some work but getting there 2013-12-09 19:28:09 -05:00
W.C.A. Wijngaards 69c6d0694b fix issue #38: install, uninstall, libtool, configureoutsidesrcdir,
the dist compiles.  library version set to 0:0:0.
2013-11-29 15:41:06 +01:00
Melinda Shore 3e0411f8f8 brought doc directory into build process ("make doc") 2013-11-21 17:39:03 -08:00
Melinda Shore 7a361f53a4 Moved project internal documents into their own directory 2013-11-21 15:49:30 -08:00
Glen Wiley 969ae95f09 added extension validation to the primary entry point to catch bogus
extension strings and perform simple type checking on extensions
brief start on man pages, moving MIT license in source code files to BSD
2013-11-04 18:37:54 -05:00
Glen Wiley a8f360e7d7 thinking 2013-08-30 11:35:18 -04:00
Glen Wiley eeefcf2fdb added trust anchor approach doc 2013-08-06 18:56:11 -04:00
Glen Wiley cce542dd07 added proposed cache design 2013-07-18 12:02:04 -04:00