changeset
Mention where the documentation lives.
Wed, 19 Feb 2014 23:15:52 -0800
- author
- Mark Doliner <mark@kingant.net>
- date
- Wed, 19 Feb 2014 23:15:52 -0800
- changeset 35592
- a8782ded6acc
- parent 35584
- a0741ee90f55
- child 35593
- ec281a1e2e5a
Mention where the documentation lives.
| README.hg | file | annotate | diff | comparison | revisions |
--- a/README.hg Mon Feb 17 11:01:18 2014 -0800 +++ b/README.hg Wed Feb 19 23:15:52 2014 -0800 @@ -19,12 +19,12 @@ check out the information available at: https://developer.pidgin.im By far the best documentation, however, is the documented code. You can pass -"--enable-gtk-doc" to ./configure before running "make" in the source tree to -generate pretty documentation using gtk-doc. Otherwise (or even if you do!), -the header files for each subsystem contain documentation for the functions they -contain. For instance, conversation.h contains documentation for the entire -purple_conversation_* API, and account.h contains documentation for the -purple_account_* API. +"--enable-gtk-doc" to ./configure then run "make" in the source tree to +generate pretty documentation in the doc/reference/*/html directories. +Otherwise (or even if you do!), the header files for each subsystem contain +documentation for the functions they contain. For instance, conversation.h +contains documentation for the entire purple_conversation_* API, and account.h +contains documentation for the purple_account_* API. If you have questions, please feel free to contact the Pidgin, Finch, and libpurple developers by email at devel@pidgin.im or on IRC at irc.freenode.net
