Sun, 13 Oct 2013 23:55:40 +0530
Replace mentions of doxygen with gtk-doc
| .hgignore | file | annotate | diff | comparison | revisions | |
| PLUGIN_HOWTO | file | annotate | diff | comparison | revisions | |
| README.hg | file | annotate | diff | comparison | revisions | |
| libpurple/dbus-analyze-functions.py | file | annotate | diff | comparison | revisions |
--- a/.hgignore Sun Oct 13 15:41:22 2013 +0530 +++ b/.hgignore Sun Oct 13 23:55:40 2013 +0530 @@ -34,7 +34,6 @@ .*\.so$ .*\.typelib$ .*\.moc$ -Doxyfile(\.mingw)?$ VERSION$ aclocal.m4 autogen.args
--- a/PLUGIN_HOWTO Sun Oct 13 15:41:22 2013 +0530 +++ b/PLUGIN_HOWTO Sun Oct 13 23:55:40 2013 +0530 @@ -2,6 +2,6 @@ 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.
--- a/README.hg Sun Oct 13 15:41:22 2013 +0530 +++ b/README.hg Sun Oct 13 23:55:40 2013 +0530 @@ -18,12 +18,13 @@ 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@pidgin.im or on IRC at irc.freenode.net
--- a/libpurple/dbus-analyze-functions.py Sun Oct 13 15:41:22 2013 +0530 +++ b/libpurple/dbus-analyze-functions.py Sun Oct 13 23:55:40 2013 +0530 @@ -68,7 +68,7 @@ ] # 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",