Commit ca0ae0be authored by Johannes Schmid's avatar Johannes Schmid Committed by Johannes Schmid

Added gtk-doc documentation (currently 12% coverage...)

2008-02-10  Johannes Schmid <jhs@gnome.org>

	* Makefile.am:
	* configure.in:
	* docs/reference/Makefile.am:
	* docs/reference/gdl-docs.sgml:
	* docs/reference/gdl-sections.txt:
	* docs/reference/gdl.types:
	Added gtk-doc documentation (currently 12% coverage...)
	
	* gdl/gdl-tools.h:
	Silece a gtk-doc warning

svn path=/trunk/; revision=424
parent 23d9a738
2008-02-10 Johannes Schmid <jhs@gnome.org>
* Makefile.am:
* configure.in:
* docs/reference/Makefile.am:
* docs/reference/gdl-docs.sgml:
* docs/reference/gdl-sections.txt:
* docs/reference/gdl.types:
Added gtk-doc documentation (currently 12% coverage...)
* gdl/gdl-tools.h:
Silece a gtk-doc warning
2008-02-04 Johannes Schmid <jhs@gnome.org>
Patch from Og Maciel <ogmaciel@gnome.org>:
......
SUBDIRS = gdl po
SUBDIRS = gdl docs po
EXTRA_DIST = \
MAINTAINERS \
......
......@@ -160,10 +160,15 @@ fi
gdl_images_dir="${packageprefix}/share/gdl/images"
AC_SUBST(gdl_images_dir)
# check for gtk-doc
GTK_DOC_CHECK(1.9)
AC_OUTPUT([
Makefile
gdl/Makefile
po/Makefile.in
docs/Makefile
docs/reference/Makefile
gdl.spec
gdl-1.0.pc
gdl-gnome-1.0.pc
......
## 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=gdl
# 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=../../gdl
# 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-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
MKTMPL_OPTIONS=
# 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)/gdl/*.h
CFILE_GLOB=$(top_srcdir)/gdl/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=gdl-data-* gdl-i18n.h libgdl*
# 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=
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_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=\
-DGDL_GLADEDIR=\""$(gladedir)"\" \
-I$(includedir) -I$(top_srcdir) \
$(WARN_CFLAGS) $(DEPRECATED_FLAGS) \
$(GDL_DEPENDENCIES_CFLAGS) $(XML_CFLAGS) \
$(GNOME_CFLAGS) \
$(EXTRA_CPPFLAGS)
GTKDOC_LIBS=$(GDL_DEPENDENCIES_LIBS) \
$(XML_LIBS) \
$(GNOME_LIBS) \
-L$(top_builddir)/gdl \
-lgdl-1 -lgdl-gnome-1
# 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 +=
# Files not to distribute
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
#DISTCLEANFILES +=
# Comment this out if you want your docs-status tested during 'make check'
TESTS = $(GTKDOC_CHECK)
<?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>gdl Reference Manual</title>
<releaseinfo>
for gdl 1.0
</releaseinfo>
</bookinfo>
<chapter id="gdl-main">
<title>Gdl - Gnome Development/Docking library</title>
<xi:include href="xml/gdl-dock-layout.xml"/>
<xi:include href="xml/gdl-dock-master.xml"/>
<xi:include href="xml/gdl-dock-item-grip.xml"/>
<xi:include href="xml/gdl-icons.xml"/>
<xi:include href="xml/gdl-dock-item.xml"/>
<xi:include href="xml/gdl-dock.xml"/>
<xi:include href="xml/gdl-dock-object.xml"/>
<xi:include href="xml/gdl-dock-tablabel.xml"/>
<xi:include href="xml/gdl-dock-notebook.xml"/>
<xi:include href="xml/gdl-dock-placeholder.xml"/>
<xi:include href="xml/gdl-combo-button.xml"/>
<xi:include href="xml/gdl-dock-paned.xml"/>
<xi:include href="xml/gdl-dock-bar.xml"/>
<xi:include href="xml/gdl-switcher.xml"/>
<xi:include href="xml/gdl-stock.xml"/>
<xi:include href="xml/gdl-tools.xml"/>
</chapter>
</book>
<SECTION>
<FILE>gdl-dock-layout</FILE>
GdlDockLayoutPrivate
<TITLE>GdlDockLayout</TITLE>
GdlDockLayout
gdl_dock_layout_new
gdl_dock_layout_attach
gdl_dock_layout_load_layout
gdl_dock_layout_save_layout
gdl_dock_layout_delete_layout
gdl_dock_layout_get_layouts
gdl_dock_layout_run_manager
gdl_dock_layout_load_from_file
gdl_dock_layout_save_to_file
gdl_dock_layout_is_dirty
gdl_dock_layout_get_ui
gdl_dock_layout_get_items_ui
gdl_dock_layout_get_layouts_ui
<SUBSECTION Standard>
GDL_DOCK_LAYOUT
GDL_IS_DOCK_LAYOUT
GDL_TYPE_DOCK_LAYOUT
gdl_dock_layout_get_type
GDL_DOCK_LAYOUT_CLASS
GDL_IS_DOCK_LAYOUT_CLASS
GDL_DOCK_LAYOUT_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-data-model</FILE>
GdlDataModel
GdlDataIter
GdlDataModelIface
gdl_data_model_get_iter
gdl_data_model_get_path
gdl_data_model_get_name
gdl_data_model_get_value
gdl_data_model_get_renderer
gdl_data_model_iter_next
gdl_data_model_iter_children
gdl_data_model_iter_has_child
<SUBSECTION Standard>
GDL_DATA_MODEL
GDL_IS_DATA_MODEL
GDL_TYPE_DATA_MODEL
gdl_data_model_get_type
GDL_DATA_MODEL_GET_IFACE
</SECTION>
<SECTION>
<FILE>gdl-dock-master</FILE>
GdlDockMasterPrivate
<TITLE>GdlDockMaster</TITLE>
GdlDockMaster
GDL_DOCK_OBJECT_GET_MASTER
gdl_dock_master_add
gdl_dock_master_remove
gdl_dock_master_foreach
gdl_dock_master_foreach_toplevel
gdl_dock_master_get_object
gdl_dock_master_get_controller
gdl_dock_master_set_controller
<SUBSECTION Standard>
GDL_DOCK_MASTER
GDL_IS_DOCK_MASTER
GDL_TYPE_DOCK_MASTER
gdl_dock_master_get_type
GDL_DOCK_MASTER_CLASS
GDL_IS_DOCK_MASTER_CLASS
GDL_DOCK_MASTER_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-icons</FILE>
<TITLE>GdlIcons</TITLE>
GdlIcons
gdl_icons_new
gdl_icons_get_folder_icon
gdl_icons_get_uri_icon
gdl_icons_get_mime_icon
<SUBSECTION Standard>
GDL_ICONS
GDL_IS_ICONS
GDL_TYPE_ICONS
gdl_icons_get_type
GDL_ICONS_CLASS
GDL_IS_ICONS_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock-item</FILE>
GdlDockItemBehavior
GdlDockItemFlags
GdlDockItemPrivate
<TITLE>GdlDockItem</TITLE>
GdlDockItem
GDL_DOCK_ITEM_FLAGS
GDL_DOCK_ITEM_IN_DRAG
GDL_DOCK_ITEM_IN_PREDRAG
GDL_DOCK_ITEM_ICONIFIED
GDL_DOCK_ITEM_USER_ACTION
GDL_DOCK_ITEM_NOT_LOCKED
GDL_DOCK_ITEM_NO_GRIP
GDL_DOCK_ITEM_SET_FLAGS
GDL_DOCK_ITEM_UNSET_FLAGS
GDL_DOCK_ITEM_HAS_GRIP
GDL_DOCK_ITEM_CANT_CLOSE
GDL_DOCK_ITEM_CANT_ICONIFY
gdl_dock_item_new
gdl_dock_item_new_with_stock
gdl_dock_item_dock_to
gdl_dock_item_set_orientation
gdl_dock_item_get_tablabel
gdl_dock_item_set_tablabel
gdl_dock_item_hide_grip
gdl_dock_item_show_grip
gdl_dock_item_bind
gdl_dock_item_unbind
gdl_dock_item_hide_item
gdl_dock_item_iconify_item
gdl_dock_item_show_item
gdl_dock_item_lock
gdl_dock_item_unlock
gdl_dock_item_set_default_position
gdl_dock_item_preferred_size
<SUBSECTION Standard>
GDL_DOCK_ITEM
GDL_IS_DOCK_ITEM
GDL_TYPE_DOCK_ITEM
gdl_dock_item_get_type
GDL_DOCK_ITEM_CLASS
GDL_IS_DOCK_ITEM_CLASS
GDL_DOCK_ITEM_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock</FILE>
GdlDockPrivate
<TITLE>GdlDock</TITLE>
GdlDock
GDL_DOCK_IS_CONTROLLER
gdl_dock_new
gdl_dock_new_from
gdl_dock_add_item
gdl_dock_add_floating_item
gdl_dock_get_item_by_name
gdl_dock_get_placeholder_by_name
gdl_dock_get_named_items
gdl_dock_object_get_toplevel
gdl_dock_xor_rect
<SUBSECTION Standard>
GDL_DOCK
GDL_IS_DOCK
GDL_TYPE_DOCK
gdl_dock_get_type
GDL_DOCK_CLASS
GDL_IS_DOCK_CLASS
GDL_DOCK_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock-object</FILE>
GdlDockParamFlags
GDL_DOCK_NAME_PROPERTY
GDL_DOCK_MASTER_PROPERTY
GdlDockObjectFlags
GDL_DOCK_OBJECT_FLAGS_SHIFT
GdlDockPlacement
GdlDockRequest
<TITLE>GdlDockObject</TITLE>
GdlDockObject
GDL_DOCK_OBJECT_FLAGS
GDL_DOCK_OBJECT_AUTOMATIC
GDL_DOCK_OBJECT_ATTACHED
GDL_DOCK_OBJECT_IN_REFLOW
GDL_DOCK_OBJECT_IN_DETACH
GDL_DOCK_OBJECT_SET_FLAGS
GDL_DOCK_OBJECT_UNSET_FLAGS
GDL_DOCK_OBJECT_FROZEN
gdl_dock_object_is_compound
gdl_dock_object_detach
gdl_dock_object_get_parent_object
gdl_dock_object_freeze
gdl_dock_object_thaw
gdl_dock_object_reduce
gdl_dock_object_dock_request
gdl_dock_object_dock
gdl_dock_object_bind
gdl_dock_object_unbind
gdl_dock_object_is_bound
gdl_dock_object_reorder
gdl_dock_object_present
gdl_dock_object_child_placement
GDL_TYPE_DOCK_PARAM
gdl_dock_param_get_type
gdl_dock_object_nick_from_type
gdl_dock_object_type_from_nick
gdl_dock_object_set_type_for_nick
GDL_TRACE_OBJECT
<SUBSECTION Standard>
GDL_DOCK_OBJECT
GDL_IS_DOCK_OBJECT
GDL_TYPE_DOCK_OBJECT
gdl_dock_object_get_type
GDL_DOCK_OBJECT_CLASS
GDL_IS_DOCK_OBJECT_CLASS
GDL_DOCK_OBJECT_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock-tablabel</FILE>
<TITLE>GdlDockTablabel</TITLE>
GdlDockTablabel
gdl_dock_tablabel_new
gdl_dock_tablabel_activate
gdl_dock_tablabel_deactivate
<SUBSECTION Standard>
GDL_DOCK_TABLABEL
GDL_IS_DOCK_TABLABEL
GDL_TYPE_DOCK_TABLABEL
gdl_dock_tablabel_get_type
GDL_DOCK_TABLABEL_CLASS
GDL_IS_DOCK_TABLABEL_CLASS
GDL_DOCK_TABLABEL_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock-notebook</FILE>
<TITLE>GdlDockNotebook</TITLE>
GdlDockNotebook
gdl_dock_notebook_new
<SUBSECTION Standard>
GDL_DOCK_NOTEBOOK
GDL_IS_DOCK_NOTEBOOK
GDL_TYPE_DOCK_NOTEBOOK
gdl_dock_notebook_get_type
GDL_DOCK_NOTEBOOK_CLASS
GDL_IS_DOCK_NOTEBOOK_CLASS
GDL_DOCK_NOTEBOOK_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock-placeholder</FILE>
GdlDockPlaceholderPrivate
<TITLE>GdlDockPlaceholder</TITLE>
GdlDockPlaceholder
gdl_dock_placeholder_new
gdl_dock_placeholder_attach
<SUBSECTION Standard>
GDL_DOCK_PLACEHOLDER
GDL_IS_DOCK_PLACEHOLDER
GDL_TYPE_DOCK_PLACEHOLDER
gdl_dock_placeholder_get_type
GDL_DOCK_PLACEHOLDER_CLASS
GDL_IS_DOCK_PLACEHOLDER_CLASS
GDL_DOCK_PLACEHOLDER_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-combo-button</FILE>
GdlComboButtonPrivate
<TITLE>GdlComboButton</TITLE>
GdlComboButton
gdl_combo_button_new
gdl_combo_button_set_icon
gdl_combo_button_set_label
gdl_combo_button_set_menu
<SUBSECTION Standard>
GDL_COMBO_BUTTON
GDL_IS_COMBO_BUTTON
GDL_TYPE_COMBO_BUTTON
gdl_combo_button_get_type
GDL_COMBO_BUTTON_CLASS
GDL_IS_COMBO_BUTTON_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock-paned</FILE>
<TITLE>GdlDockPaned</TITLE>
GdlDockPaned
gdl_dock_paned_new
<SUBSECTION Standard>
GDL_DOCK_PANED
GDL_IS_DOCK_PANED
GDL_TYPE_DOCK_PANED
gdl_dock_paned_get_type
GDL_DOCK_PANED_CLASS
GDL_IS_DOCK_PANED_CLASS
GDL_DOCK_PANED_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-data-row</FILE>
GdlDataRowPrivate
<TITLE>GdlDataRow</TITLE>
GdlDataRow
gdl_data_row_new
gdl_data_row_get_size
gdl_data_row_set_show_name
gdl_data_row_layout
gdl_data_row_render
gdl_data_row_at
gdl_data_row_event
gdl_data_row_get_cell_area
gdl_data_row_set_split
gdl_data_row_set_selected
gdl_data_row_set_focused
gdl_data_row_get_title
<SUBSECTION Standard>
GDL_DATA_ROW
GDL_IS_DATA_ROW
GDL_TYPE_DATA_ROW
gdl_data_row_get_type
GDL_DATA_ROW_CLASS
GDL_IS_DATA_ROW_CLASS
</SECTION>
<SECTION>
<FILE>gdl-dock-bar</FILE>
GdlDockBarPrivate
GdlDockBarStyle
<TITLE>GdlDockBar</TITLE>
GdlDockBar
gdl_dock_bar_new
gdl_dock_bar_get_orientation
gdl_dock_bar_set_orientation
gdl_dock_bar_set_style
gdl_dock_bar_get_style
<SUBSECTION Standard>
GDL_DOCK_BAR
GDL_IS_DOCK_BAR
GDL_TYPE_DOCK_BAR
gdl_dock_bar_get_type
GDL_DOCK_BAR_CLASS
GDL_IS_DOCK_BAR_CLASS
GDL_DOCK_BAR_GET_CLASS
</SECTION>
<SECTION>
<FILE>gdl-switcher</FILE>
GdlSwitcherPrivate
GdlSwitcherStyle
<TITLE>GdlSwitcher</TITLE>
GdlSwitcher
gdl_switcher_new
gdl_switcher_insert_page
<SUBSECTION Standard>
GDL_SWITCHER
GDL_IS_SWITCHER
GDL_TYPE_SWITCHER
gdl_switcher_get_type
GDL_SWITCHER_CLASS
GDL_IS_SWITCHER_CLASS
</SECTION>
<SECTION>
<FILE>gdl</FILE>
</SECTION>
<SECTION>
<FILE>gdl-stock</FILE>
GDL_STOCK_CLOSE
GDL_STOCK_MENU_LEFT
GDL_STOCK_MENU_RIGHT
gdl_stock_init
</SECTION>
<SECTION>
<FILE>gdl-tools</FILE>
DO_GDL_TRACE
GDL_TRACE
GDL_TRACE_EXTRA
GDL_BOILERPLATE
GDL_CALL_PARENT
GDL_CALL_PARENT_GBOOLEAN
GDL_CALL_PARENT_WITH_DEFAULT
GDL_CLASS_BOILERPLATE
GDL_REGISTER_TYPE
GDL_CALL_VIRTUAL
GDL_CALL_VIRTUAL_WITH_DEFAULT
GdlPixmap
GDL_PIXMAP
GDL_PIXMAP_END
</SECTION>
gdl_dock_layout_get_type
gdl_dock_master_get_type
gdl_icons_get_type
gdl_dock_item_get_type
gdl_dock_get_type
gdl_dock_object_get_type
gdl_dock_param_get_type
gdl_dock_tablabel_get_type
gdl_dock_notebook_get_type
gdl_dock_placeholder_get_type
gdl_combo_button_get_type
gdl_dock_paned_get_type
gdl_dock_bar_get_type
gdl_dock_param_flags_get_type
gdl_dock_object_flags_get_type
gdl_dock_placement_get_type
gdl_dock_item_behavior_get_type
gdl_dock_item_flags_get_type
gdl_dock_bar_style_get_type
gdl_switcher_style_get_type
gdl_switcher_get_type
......@@ -79,9 +79,10 @@ G_BEGIN_DECLS
#endif /* DO_GDL_TRACE */
/**
/*
* Class boilerplate and base class call macros copied from
* bonobo/bonobo-macros.h. Original copyright follows.
*
*
* Author:
* Darin Adler <darin@bentspoon.com>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment