/pidgin/main: a8782ded6acc: Mention where the documentation lives.

Mark Doliner mark at kingant.net
Thu Feb 20 02:16:21 EST 2014


Changeset: a8782ded6acca9e5aac79cea9df8b55c638828cd
Author:	 Mark Doliner <mark at kingant.net>
Date:	 2014-02-19 23:15 -0800
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/a8782ded6acc

Description:

Mention where the documentation lives.

diffstat:

 README.hg |  12 ++++++------
 1 files changed, 6 insertions(+), 6 deletions(-)

diffs (22 lines):

diff --git a/README.hg b/README.hg
--- a/README.hg
+++ b/README.hg
@@ -19,12 +19,12 @@ If you are interested in hacking on Pidg
 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 at pidgin.im or on IRC at irc.freenode.net



More information about the Commits mailing list