/soc/2013/ankitkv/gobjectification: de331168e981: Prepare more f...
Ankit Vani
a at nevitus.org
Fri Jan 31 07:28:58 EST 2014
Changeset: de331168e98175a5797946fc4655e2ee3ea93968
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 17:48 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/de331168e981
Description:
Prepare more for gtk-doc
diffstat:
.hgignore | 18 ++++++++++++++++++
ChangeLog | 1 +
PLUGIN_HOWTO | 6 +++---
README.hg | 13 +++++++------
autogen.sh | 3 +++
config.h.mingw | 6 ------
finch/libgnt/configure.ac | 2 +-
7 files changed, 33 insertions(+), 16 deletions(-)
diffs (139 lines):
diff --git a/.hgignore b/.hgignore
--- a/.hgignore
+++ b/.hgignore
@@ -50,8 +50,20 @@ depcomp
doc/finch.1$
doc/html
doc/pidgin.1$
+doc/reference/.*/.*\.args
+doc/reference/.*/.*\.hierarchy
+doc/reference/.*/.*\.interfaces
+doc/reference/.*/.*\.prerequisites
+doc/reference/.*/.*\.signals
+doc/reference/.*/.*\.stamp
+doc/reference/.*/.*\.txt
+doc/reference/.*/.*\.types
+doc/reference/.*/html/.*
+doc/reference/.*/xml/.*
+doc/reference/.*/version.xml
finch/finch$
finch/libgnt/gntmarshal.[ch]
+gtk-doc.make
install-sh
intltool-.*
libpurple/dbus-bindings.c
@@ -78,6 +90,12 @@ libpurple/win32/libpurplerc.rc$
libtool
local.mak
ltmain.sh
+m4macros/gtk-doc.m4
+m4macros/intltool.m4
+m4macros/ltoptions.m4
+m4macros/ltsugar.m4
+m4macros/ltversion.m4
+m4macros/lt~obsolete.m4
missing
mkinstalldirs
package_revision.h
diff --git a/ChangeLog b/ChangeLog
--- a/ChangeLog
+++ b/ChangeLog
@@ -60,6 +60,7 @@ version 3.0.0 (??/??/????):
General:
* Various core components of libpurple are now GObjects.
* Ciphers are now built from the libpurple directory.
+ * Doxygen has been replaced by gtk-doc for generating documentation.
version 2.10.8 (1/28/2014):
General:
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/autogen.sh b/autogen.sh
--- a/autogen.sh
+++ b/autogen.sh
@@ -34,6 +34,7 @@
# AUTOMAKE_FLAGS - command line arguments to pass to automake flags
# CONFIGURE_FLAGS - command line arguments to pass to configure
# GLIB_GETTEXTIZE_FLAGS - command line arguments to pass to glib-gettextize
+# GTKDOCIZE_FLAGS - command line arguments to pass to gtkdocize
# INTLTOOLIZE_FLAGS - command line arguments to pass to intltoolize
# LIBTOOLIZE_FLAGS - command line arguments to pass to libtoolize
#
@@ -136,6 +137,7 @@ fi
###############################################################################
check "$libtoolize"; LIBTOOLIZE=${BIN};
check "glib-gettextize"; GLIB_GETTEXTIZE=${BIN};
+check "gtkdocize"; GTKDOCIZE=${BIN};
check "intltoolize"; INTLTOOLIZE=${BIN};
check "sed"; SED=${BIN};
check "aclocal"; ACLOCAL=${BIN};
@@ -155,6 +157,7 @@ run_or_die ${SED} -i -e "s:'\^\$\$lang\$
# glib-gettextize doesn't seems to use AM_V_GEN macro
${SED} -i -e "s:\\tfile=\`echo:\\t at echo -e \" GEN\\\\t\$\@\"; file=\`echo:g" po/Makefile.in.in
run_or_die ${ACLOCAL} ${ACLOCAL_FLAGS:-"-I m4macros"}
+run_or_die ${GTKDOCIZE} ${GTKDOCIZE_FLAGS}
run_or_die ${AUTOHEADER} ${AUTOHEADER_FLAGS}
run_or_die ${AUTOMAKE} ${AUTOMAKE_FLAGS:-"-a -c --gnu"}
run_or_die ${AUTOCONF} ${AUTOCONF_FLAGS}
diff --git a/config.h.mingw b/config.h.mingw
--- a/config.h.mingw
+++ b/config.h.mingw
@@ -48,12 +48,6 @@
/* Define to 1 if you have the <dlfcn.h> header file. */
/* #undef HAVE_DLFCN_H */
-/* whether or not we have dot */
-/* #undef HAVE_DOT */
-
-/* whether or not we have doxygen */
-/* #undef HAVE_DOXYGEN */
-
/* Define if we're using evolution addressbook. */
/* #undef HAVE_EVOLUTION_ADDRESSBOOK */
diff --git a/finch/libgnt/configure.ac b/finch/libgnt/configure.ac
--- a/finch/libgnt/configure.ac
+++ b/finch/libgnt/configure.ac
@@ -42,7 +42,7 @@ AM_INIT_AUTOMAKE(AC_PACKAGE_NAME, AC_PAC
GNT_MAJOR_VERSION=gnt_major_version
GNT_MINOR_VERSION=gnt_minor_version
GNT_MICRO_VERSION=gnt_micro_version
-GNT_VERSION=[gnt_display_version]
+GNT_VERSION=gnt_display_version
AC_SUBST(GNT_MAJOR_VERSION)
AC_SUBST(GNT_MINOR_VERSION)
AC_SUBST(GNT_MICRO_VERSION)
More information about the Commits
mailing list