/soc/2013/ankitkv/gobjectification: 9c7d11ed7d99: Replace mentio...

[Ankit Vani]

Changeset: 9c7d11ed7d99126e9b8118bc7121a50803883c1c
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-10-13 23:55 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/9c7d11ed7d99

Description:

Replace mentions of doxygen with gtk-doc

diffstat:

 .hgignore                           |   1 -
 PLUGIN_HOWTO                        |   6 +++---
 README.hg                           |  13 +++++++------
 libpurple/dbus-analyze-functions.py |   2 +-
 4 files changed, 11 insertions(+), 11 deletions(-)

diffs (59 lines):

diff --git a/.hgignore b/.hgignore
--- a/.hgignore
+++ b/.hgignore
@@ -34,7 +34,6 @@ syntax: regexp
 .*\.so$
 .*\.typelib$
 .*\.moc$
-Doxyfile(\.mingw)?$
 VERSION$
 aclocal.m4
 autogen.args
diff --git a/PLUGIN_HOWTO b/PLUGIN_HOWTO
--- a/PLUGIN_HOWTO
+++ b/PLUGIN_HOWTO
@@ -2,6 +2,6 @@ For information on writing a plugin for 
 https://developer.pidgin.im and click on API.  From there, see the
 HOWTOs in the "Related Pages" section.
 
-You can also generate this documentation locally by installing
-doxygen and graphviz dot, then running "make docs" in the
-source tree.  The documentation will be in the docs/html directory.
+You can also generate this documentation locally by passing
+"--enable-gtk-doc" to ./configure, then running "make" in the source tree.
+The documentation will be in the doc/reference/*/html directories.
diff --git a/README.hg b/README.hg
--- a/README.hg
+++ b/README.hg
@@ -18,12 +18,13 @@ development bugs that we already know ab
 If you are interested in hacking on Pidgin, Finch, and/or libpurple, please
 check out the information available at: https://developer.pidgin.im
 
-By far the best documentation, however, is the documented code.  If you have
-doxygen, you can run "make docs" in the toplevel directory to generate pretty
-documentation.  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.
+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.
 
 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
diff --git a/libpurple/dbus-analyze-functions.py b/libpurple/dbus-analyze-functions.py
--- a/libpurple/dbus-analyze-functions.py
+++ b/libpurple/dbus-analyze-functions.py
@@ -68,7 +68,7 @@ stringlists = [
 ]
 
 # This is a list of functions that return a GList* or GSList* that should
-# not be freed.  Ideally, this information should be obtained from the Doxygen
+# not be freed.  Ideally, this information should be obtained from the gtk-doc
 # documentation at some point.
 constlists = [
     "purple_account_get_status_types",