Commit f600051d authored by Xavier Claessens's avatar Xavier Claessens Committed by Xavier Claessens

Adding initial API documentation using gtk-doc.

2007-07-12 Xavier Claessens  <xclaesse@gmail.com>

	* configure.ac:
	* doc/*:
	* Makefile.am: Adding initial API documentation using gtk-doc.


svn path=/trunk/; revision=182
parent 8f27d600
2007-07-12 Xavier Claessens <xclaesse@gmail.com>
* configure.ac:
* doc/*:
* Makefile.am: Adding initial API documentation using gtk-doc.
2007-07-12 Xavier Claessens <xclaesse@gmail.com>
* libempathy/empathy-tp-contact-list.c: Auto-accept to publish presence
......
SUBDIRS = po data libempathy libempathy-gtk src
SUBDIRS = po data libempathy libempathy-gtk src doc
DISTCHECK_CONFIGURE_FLAGS = \
--disable-scrollkeeper
......
......@@ -21,6 +21,8 @@ AM_GCONF_SOURCE_2
IT_PROG_INTLTOOL([0.35.0])
GTK_DOC_CHECK([1.3])
GLIB_REQUIRED=2.12.0
GTK_REQUIRED=2.10.0
GCONF_REQUIRED=1.2.0
......@@ -137,5 +139,8 @@ AC_OUTPUT([
libempathy-gtk/Makefile
libempathy-gtk/libempathy-gtk.pc
src/Makefile
doc/Makefile \
doc/libempathy/Makefile \
doc/libempathy-gtk/Makefile \
])
SUBDIRS = libempathy libempathy-gtk
## Process this file with automake to produce Makefile.in
# We require automake 1.6 at least.
AUTOMAKE_OPTIONS = 1.6
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
# of using the various options.
# The name of the module, e.g. 'glib'.
DOC_MODULE=libempathy-gtk
# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
DOC_SOURCE_DIR=../../libempathy-gtk
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
SCANGOBJ_OPTIONS=
# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
SCAN_OPTIONS=
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS=
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB=$(top_srcdir)/libempathy-gtk/*.h
CFILE_GLOB=$(top_srcdir)/libempathy-gtk/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES=
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files=
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
INCLUDES=-I$(top_srcdir) $(EMPATHY_CFLAGS)
GTKDOC_LIBS=$(top_builddir)/libempathy-gtk/libempathy-gtk.la $(EMPATHY_LIBS)
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
EXTRA_DIST +=
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>libempathy-gtk Reference Manual</title>
</bookinfo>
<chapter>
<title>libempathy-gtk API reference</title>
<xi:include href="xml/empathy-about-dialog.xml"/>
<xi:include href="xml/empathy-cell-renderer-text.xml"/>
<xi:include href="xml/empathy-contact-list-store.xml"/>
<xi:include href="xml/empathy-main-window.xml"/>
<xi:include href="xml/empathy-spell.xml"/>
<xi:include href="xml/empathy-account-chooser.xml"/>
<xi:include href="xml/empathy-chat.xml"/>
<xi:include href="xml/empathy-contact-list-view.xml"/>
<xi:include href="xml/empathy-new-chatroom-dialog.xml"/>
<xi:include href="xml/empathy-status-icon.xml"/>
<xi:include href="xml/empathy-accounts-dialog.xml"/>
<xi:include href="xml/empathy-chatrooms-window.xml"/>
<xi:include href="xml/empathy-contact-widget.xml"/>
<xi:include href="xml/empathy-preferences.xml"/>
<xi:include href="xml/empathy-status-presets.xml"/>
<xi:include href="xml/empathy-account-widget-generic.xml"/>
<xi:include href="xml/empathy-chat-view.xml"/>
<xi:include href="xml/empathy-geometry.xml"/>
<xi:include href="xml/empathy-presence-chooser.xml"/>
<xi:include href="xml/empathy-theme-manager.xml"/>
<xi:include href="xml/empathy-account-widget-jabber.xml"/>
<xi:include href="xml/empathy-chat-window.xml"/>
<xi:include href="xml/empathy-group-chat.xml"/>
<xi:include href="xml/empathy-private-chat.xml"/>
<xi:include href="xml/empathy-ui-utils.xml"/>
<xi:include href="xml/empathy-account-widget-msn.xml"/>
<xi:include href="xml/empathy-contact-dialogs.xml"/>
<xi:include href="xml/empathy-images.xml"/>
<xi:include href="xml/empathy-profile-chooser.xml"/>
<xi:include href="xml/ephy-spinner.xml"/>
<xi:include href="xml/empathy-cell-renderer-expander.xml"/>
<xi:include href="xml/empathy-contact-groups.xml"/>
<xi:include href="xml/empathy-log-window.xml"/>
<xi:include href="xml/empathy-spell-dialog.xml"/>
</chapter>
</book>
#include <libempathy-gtk/empathy-cell-renderer-text.h>
#include <libempathy-gtk/empathy-contact-list-store.h>
#include <libempathy-gtk/empathy-chat.h>
#include <libempathy-gtk/empathy-chat-window.h>
#include <libempathy-gtk/empathy-contact-list-view.h>
#include <libempathy-gtk/empathy-status-icon.h>
#include <libempathy-gtk/empathy-chat-view.h>
#include <libempathy-gtk/empathy-presence-chooser.h>
#include <libempathy-gtk/empathy-theme-manager.h>
#include <libempathy-gtk/empathy-group-chat.h>
#include <libempathy-gtk/empathy-private-chat.h>
#include <libempathy-gtk/ephy-spinner.h>
#include <libempathy-gtk/empathy-cell-renderer-expander.h>
empathy_cell_renderer_text_get_type
empathy_contact_list_store_get_type
empathy_chat_get_type
empathy_chat_window_get_type
empathy_contact_list_view_get_type
empathy_status_icon_get_type
empathy_chat_view_get_type
empathy_presence_chooser_get_type
empathy_theme_manager_get_type
empathy_group_chat_get_type
empathy_private_chat_get_type
ephy_spinner_get_type
empathy_cell_renderer_expander_get_type
<!-- ##### SECTION Title ##### -->
empathy-about-dialog
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION empathy_about_dialog_new ##### -->
<para>
</para>
@parent:
<!-- ##### SECTION Title ##### -->
EmpathyAccountChooser
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT EmpathyAccountChooser ##### -->
<para>
</para>
@parent:
<!-- ##### FUNCTION empathy_account_chooser_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION empathy_account_chooser_get_account ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION empathy_account_chooser_set_account ##### -->
<para>
</para>
@chooser:
@account:
@Returns:
<!-- ##### FUNCTION empathy_account_chooser_get_can_select_all ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION empathy_account_chooser_set_can_select_all ##### -->
<para>
</para>
@chooser:
@can_select_all:
<!-- ##### FUNCTION empathy_account_chooser_get_has_all_option ##### -->
<para>
</para>
@chooser:
@Returns:
<!-- ##### FUNCTION empathy_account_chooser_set_has_all_option ##### -->
<para>
</para>
@chooser:
@has_all_option:
<!-- ##### SECTION Title ##### -->
empathy-account-widget-generic
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION empathy_account_widget_generic_new ##### -->
<para>
</para>
@account:
@label_name:
@Returns:
<!-- ##### SECTION Title ##### -->
empathy-account-widget-jabber
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION empathy_account_widget_jabber_new ##### -->
<para>
</para>
@account:
@Returns:
<!-- ##### SECTION Title ##### -->
empathy-account-widget-msn
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION empathy_account_widget_msn_new ##### -->
<para>
</para>
@account:
@Returns:
<!-- ##### SECTION Title ##### -->
empathy-accounts-dialog
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION empathy_accounts_dialog_show ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### SECTION Title ##### -->
EmpathyCellRendererExpander
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT EmpathyCellRendererExpander ##### -->
<para>
</para>
<!-- ##### ARG EmpathyCellRendererExpander:activatable ##### -->
<para>
</para>
<!-- ##### ARG EmpathyCellRendererExpander:expander-size ##### -->
<para>
</para>
<!-- ##### ARG EmpathyCellRendererExpander:expander-style ##### -->
<para>
</para>
<!-- ##### FUNCTION empathy_cell_renderer_expander_new ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION Title ##### -->
EmpathyCellRendererText
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT EmpathyCellRendererTextPriv ##### -->
<para>
</para>
<!-- ##### STRUCT EmpathyCellRendererText ##### -->
<para>
</para>
<!-- ##### ARG EmpathyCellRendererText:is-group ##### -->
<para>
</para>
<!-- ##### ARG EmpathyCellRendererText:name ##### -->
<para>
</para>
<!-- ##### ARG EmpathyCellRendererText:show-status ##### -->
<para>
</para>
<!-- ##### ARG EmpathyCellRendererText:status ##### -->
<para>
</para>
<!-- ##### FUNCTION empathy_cell_renderer_text_new ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION Title ##### -->
EmpathyChatView
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT EmpathyChatViewPriv ##### -->
<para>
</para>
<!-- ##### STRUCT EmpathyChatView ##### -->
<para>
</para>
<!-- ##### ENUM EmpathySmiley ##### -->
<para>
</para>
@EMPATHY_SMILEY_NORMAL:
@EMPATHY_SMILEY_WINK:
@EMPATHY_SMILEY_BIGEYE:
@EMPATHY_SMILEY_NOSE:
@EMPATHY_SMILEY_CRY:
@EMPATHY_SMILEY_SAD:
@EMPATHY_SMILEY_SCEPTICAL:
@EMPATHY_SMILEY_BIGSMILE:
@EMPATHY_SMILEY_INDIFFERENT:
@EMPATHY_SMILEY_TOUNGE:
@EMPATHY_SMILEY_SHOCKED:
@EMPATHY_SMILEY_COOL:
@EMPATHY_SMILEY_SORRY:
@EMPATHY_SMILEY_KISS:
@EMPATHY_SMILEY_SHUTUP:
@EMPATHY_SMILEY_YAWN:
@EMPATHY_SMILEY_CONFUSED:
@EMPATHY_SMILEY_ANGEL:
@EMPATHY_SMILEY_OOOH:
@EMPATHY_SMILEY_LOOKAWAY:
@EMPATHY_SMILEY_BLUSH:
@EMPATHY_SMILEY_COOLBIGSMILE:
@EMPATHY_SMILEY_ANGRY:
@EMPATHY_SMILEY_BOSS:
@EMPATHY_SMILEY_MONKEY:
@EMPATHY_SMILEY_SILLY:
@EMPATHY_SMILEY_SICK:
@EMPATHY_SMILEY_COUNT:
<!-- ##### FUNCTION empathy_chat_view_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION empathy_chat_view_append_message ##### -->
<para>
</para>
@view:
@msg:
<!-- ##### FUNCTION empathy_chat_view_append_event ##### -->
<para>
</para>
@view:
@str:
<!-- ##### FUNCTION empathy_chat_view_append_button ##### -->
<para>
</para>
@view:
@message:
@button1:
@button2:
<!-- ##### FUNCTION empathy_chat_view_set_margin ##### -->
<para>
</para>
@view:
@margin:
<!-- ##### FUNCTION empathy_chat_view_scroll ##### -->
<para>
</para>
@view:
@allow_scrolling:
<!-- ##### FUNCTION empathy_chat_view_scroll_down ##### -->
<para>
</para>
@view:
<!-- ##### FUNCTION empathy_chat_view_get_selection_bounds ##### -->
<para>
</para>
@view:
@start:
@end:
@Returns:
<!-- ##### FUNCTION empathy_chat_view_clear ##### -->
<para>
</para>
@view:
<!-- ##### FUNCTION empathy_chat_view_find_previous ##### -->
<para>
</para>
@view:
@search_criteria:
@new_search:
@Returns:
<!-- ##### FUNCTION empathy_chat_view_find_next ##### -->
<para>
</para>
@view:
@search_criteria:
@new_search:
@Returns:
<!-- ##### FUNCTION empathy_chat_view_find_abilities ##### -->
<para>
</para>
@view:
@search_criteria:
@can_do_previous:
@can_do_next:
<!-- ##### FUNCTION empathy_chat_view_highlight ##### -->
<para>
</para>
@view:
@text:
<!-- ##### FUNCTION empathy_chat_view_copy_clipboard ##### -->
<para>
</para>
@view:
<!-- ##### FUNCTION empathy_chat_view_get_irc_style ##### -->
<para>
</para>