Added gtk-doc directory and Makefile.am
authorBill Haneman <billh@src.gnome.org>
Fri, 11 May 2001 16:43:24 +0000 (16:43 +0000)
committerBill Haneman <billh@src.gnome.org>
Fri, 11 May 2001 16:43:24 +0000 (16:43 +0000)
docs/Makefile.am [new file with mode: 0644]
docs/atk-api.sgml [new file with mode: 0644]
docs/atk-docs.sgml [new file with mode: 0644]
docs/atk-sections.txt [new file with mode: 0644]

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644 (file)
index 0000000..7a728a8
--- /dev/null
@@ -0,0 +1,40 @@
+## Process this file with automake to produce Makefile.in
+
+# The name of the module.
+DOC_MODULE=atk
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=atk-docs.sgml
+
+# The directory containing the source code (if it contains documentation).
+DOC_SOURCE_DIR=../atk
+
+
+TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+
+scan:
+       gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="libgnomeP.h gnome-i18nP.h gnome-triggersP.h gnome-magic.h vroot.h"
+
+templates: scan
+       gtkdoc-mktmpl --module=$(DOC_MODULE)
+
+sgml:
+       gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
+
+html:
+       if test ! -d html ; then mkdir html ; fi
+       -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
+
+clean-local:
+       rm -f *~ *.bak *.hierarchy *.signals *.args *-unused.txt
+
+maintainer-clean-local: clean-local
+       rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt 
+
+install-data-local:
+       install -d -m 0755 $(TARGET_DIR)
+       install -m 0644 html/*.html $(TARGET_DIR)
+       install -m 0644 html/index.sgml $(TARGET_DIR)
+       gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)
+
+.PHONY : html sgml templates scan
diff --git a/docs/atk-api.sgml b/docs/atk-api.sgml
new file mode 100644 (file)
index 0000000..f384631
--- /dev/null
@@ -0,0 +1,51 @@
+<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!entity atkcomponent SYSTEM "sgml/atkcomponent.sgml">
+<!entity atkaction SYSTEM "sgml/atkaction.sgml">
+<!entity atkcomponent SYSTEM "sgml/atkcomponent.sgml">
+<!entity atkeditabletext SYSTEM "sgml/atkeditabletext.sgml">
+<!entity atkhyperlink SYSTEM "sgml/atkhyperlink.sgml">
+<!entity atkhypertext SYSTEM "sgml/atkhypertext.sgml">
+<!entity atkimage SYSTEM "sgml/atkimage.sgml">
+<!entity atknoopobject SYSTEM "sgml/atknoopobject.sgml">
+<!entity atknoopobjectfactory SYSTEM "sgml/atknoopobjectfactory.sgml">
+<!entity atkobject SYSTEM "sgml/atkobject.sgml">
+<!entity atkobjectfactory SYSTEM "sgml/atkobjectfactory.sgml">
+<!entity atkregistry SYSTEM "sgml/atkregistry.sgml">
+<!entity atkselection SYSTEM "sgml/atkselection.sgml">
+<!entity atktable SYSTEM "sgml/atktable.sgml">
+<!entity atktext SYSTEM "sgml/atktext.sgml">
+<!entity atkutil SYSTEM "sgml/atkutil.sgml">
+<!entity atkvalue SYSTEM "sgml/atkvalue.sgml">
+
+]>
+
+<book>
+  <bookinfo>
+    <title>ATK Library Reference Manual</title>
+  </bookinfo>
+
+  <chapter id="atk">
+    <title>ATK Library</title>
+
+       <sect1 id="test123">
+       <title>section 1</title>
+          &atkaction
+          &atkcomponent
+          &atkeditabletext
+          &atkhyperlink
+          &atkhypertext
+          &atkimage
+          &atknoopobject
+          &atknoopobjectfactory
+          &atkobject
+          &atkobjectfactory
+          &atkregistry
+          &atkselection
+          &atktable
+          &atktext
+          &atkutil
+          &atkvalue
+       </sect1>
+   </chapter>
+</book>
+
diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml
new file mode 100644 (file)
index 0000000..f384631
--- /dev/null
@@ -0,0 +1,51 @@
+<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!entity atkcomponent SYSTEM "sgml/atkcomponent.sgml">
+<!entity atkaction SYSTEM "sgml/atkaction.sgml">
+<!entity atkcomponent SYSTEM "sgml/atkcomponent.sgml">
+<!entity atkeditabletext SYSTEM "sgml/atkeditabletext.sgml">
+<!entity atkhyperlink SYSTEM "sgml/atkhyperlink.sgml">
+<!entity atkhypertext SYSTEM "sgml/atkhypertext.sgml">
+<!entity atkimage SYSTEM "sgml/atkimage.sgml">
+<!entity atknoopobject SYSTEM "sgml/atknoopobject.sgml">
+<!entity atknoopobjectfactory SYSTEM "sgml/atknoopobjectfactory.sgml">
+<!entity atkobject SYSTEM "sgml/atkobject.sgml">
+<!entity atkobjectfactory SYSTEM "sgml/atkobjectfactory.sgml">
+<!entity atkregistry SYSTEM "sgml/atkregistry.sgml">
+<!entity atkselection SYSTEM "sgml/atkselection.sgml">
+<!entity atktable SYSTEM "sgml/atktable.sgml">
+<!entity atktext SYSTEM "sgml/atktext.sgml">
+<!entity atkutil SYSTEM "sgml/atkutil.sgml">
+<!entity atkvalue SYSTEM "sgml/atkvalue.sgml">
+
+]>
+
+<book>
+  <bookinfo>
+    <title>ATK Library Reference Manual</title>
+  </bookinfo>
+
+  <chapter id="atk">
+    <title>ATK Library</title>
+
+       <sect1 id="test123">
+       <title>section 1</title>
+          &atkaction
+          &atkcomponent
+          &atkeditabletext
+          &atkhyperlink
+          &atkhypertext
+          &atkimage
+          &atknoopobject
+          &atknoopobjectfactory
+          &atkobject
+          &atkobjectfactory
+          &atkregistry
+          &atkselection
+          &atktable
+          &atktext
+          &atkutil
+          &atkvalue
+       </sect1>
+   </chapter>
+</book>
+
diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt
new file mode 100644 (file)
index 0000000..828b2eb
--- /dev/null
@@ -0,0 +1,399 @@
+<SECTION>
+<FILE>atkaction</FILE>
+ATK_ACTION_GET_IFACE
+AtkAction
+AtkActionIface
+atk_action_do_action
+atk_action_get_n_actions
+atk_action_get_description
+atk_action_get_keybinding
+<SUBSECTION Standard>
+ATK_ACTION
+ATK_IS_ACTION
+ATK_TYPE_ACTION
+atk_action_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atkcomponent</FILE>
+ATK_COMPONENT_GET_IFACE
+AtkComponent
+AtkComponentIface
+AtkFocusHandler
+atk_component_add_focus_handler
+atk_component_contains
+atk_component_get_accessible_at_point
+atk_component_get_extents
+atk_component_get_position
+atk_component_get_position_on_screen
+atk_component_get_size
+atk_component_grab_focus
+atk_component_remove_focus_handler
+atk_component_set_extents
+atk_component_set_position
+atk_component_set_size
+<SUBSECTION Standard>
+ATK_COMPONENT
+ATK_IS_COMPONENT
+ATK_TYPE_COMPONENT
+atk_component_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atkeditabletext</FILE>
+ATK_EDITABLE_TEXT_GET_IFACE
+AtkEditableText
+AtkEditableTextIface
+atk_editable_text_select_text
+atk_editable_text_set_attributes
+atk_editable_text_set_text_contents
+atk_editable_text_insert_text
+atk_editable_text_copy_text
+atk_editable_text_cut_text
+atk_editable_text_delete_text
+atk_editable_text_paste_text
+<SUBSECTION Standard>
+ATK_EDITABLE_TEXT
+ATK_IS_EDITABLE_TEXT
+ATK_TYPE_EDITABLE_TEXT
+atk_editable_text_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atkhyperlink</FILE>
+<TITLE>AtkHyperlink</TITLE>
+atk_hyperlink_get_anchor
+atk_hyperlink_get_object
+atk_hyperlink_get_end_index
+atk_hyperlink_get_start_index
+atk_hyperlink_is_valid
+<SUBSECTION Standard>
+ATK_HYPERLINK
+ATK_IS_HYPERLINK
+ATK_TYPE_HYPERLINK
+atk_hyperlink_get_type
+ATK_HYPERLINK_CLASS
+ATK_IS_HYPERLINK_CLASS
+ATK_HYPERLINK_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atkhypertext</FILE>
+ATK_HYPERTEXT_GET_IFACE
+AtkHypertext
+AtkHypertextIface
+AtkHyperLink
+atk_hypertext_get_link
+atk_hypertext_get_n_links
+atk_hypertext_get_link_index
+<SUBSECTION Standard>
+ATK_HYPERTEXT
+ATK_IS_HYPERTEXT
+ATK_TYPE_HYPERTEXT
+atk_hypertext_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atkimage</FILE>
+ATK_IMAGE_GET_IFACE
+AtkImage
+AtkImageIface
+AtkImageType
+atk_image_get_storage_type
+atk_image_get_image_description
+atk_image_get_image_height
+atk_image_get_image_width
+atk_image_set_image_description
+<SUBSECTION Standard>
+ATK_IMAGE
+ATK_IS_IMAGE
+ATK_TYPE_IMAGE
+atk_image_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atknoopobject</FILE>
+<TITLE>AtkNoOpObject</TITLE>
+atk_no_op_object_new
+<SUBSECTION Standard>
+ATK_NO_OP_OBJECT
+ATK_IS_NO_OP_OBJECT
+ATK_TYPE_NO_OP_OBJECT
+agtk_widget_get_type
+ATK_NO_OP_OBJECT_CLASS
+ATK_IS_NO_OP_OBJECT_CLASS
+ATK_NO_OP_OBJECT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atknoopobjectfactory</FILE>
+<TITLE>AtkNoOpObjectFactory</TITLE>
+atk_no_op_object_factory_new
+<SUBSECTION Standard>
+ATK_NO_OP_OBJECT_FACTORY
+ATK_IS_NO_OP_OBJECT_FACTORY
+ATK_TYPE_NO_OP_OBJECT_FACTORY
+atk_no_op_object_factory_get_type
+ATK_NO_OP_OBJECT_FACTORY_CLASS
+ATK_IS_NO_OP_OBJECT_FACTORY_CLASS
+ATK_NO_OP_OBJECT_FACTORY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atkobject</FILE>
+AtkChildChangeType
+AtkRole
+atk_role_register
+ATK_TYPE_IMPLEMENTOR
+ATK_IS_IMPLEMENTOR
+ATK_IMPLEMENTOR
+ATK_IMPLEMENTOR_GET_IFACE
+AtkImplementor
+AtkImplementorIface
+AtkRelationSet
+AtkStateSet
+AtkPropertyValues
+AtkPropertyChangeHandler
+<TITLE>AtkObject</TITLE>
+atk_implementor_get_type
+atk_implementor_ref_accessible
+atk_object_get_name
+atk_object_get_description
+atk_object_get_parent
+atk_object_get_n_accessible_children
+atk_object_ref_accessible_child
+atk_object_ref_relation_set
+atk_object_get_role
+atk_object_ref_state_set
+atk_object_get_index_in_parent
+atk_object_set_name
+atk_object_set_description
+atk_object_set_parent
+atk_object_set_role
+atk_object_connect_property_change_handler
+atk_object_remove_property_change_handler
+<SUBSECTION Standard>
+ATK_OBJECT
+ATK_IS_OBJECT
+ATK_TYPE_OBJECT
+atk_object_get_type
+ATK_OBJECT_CLASS
+ATK_IS_OBJECT_CLASS
+ATK_OBJECT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atkobjectfactory</FILE>
+<TITLE>AtkObjectFactory</TITLE>
+atk_object_factory_create_accessible
+atk_object_factory_invalidate
+<SUBSECTION Standard>
+ATK_OBJECT_FACTORY
+ATK_IS_OBJECT_FACTORY
+ATK_TYPE_OBJECT_FACTORY
+atk_object_factory_get_type
+ATK_OBJECT_FACTORY_CLASS
+ATK_IS_OBJECT_FACTORY_CLASS
+ATK_OBJECT_FACTORY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atkregistry</FILE>
+<TITLE>AtkRegistry</TITLE>
+atk_registry_set_factory_type
+atk_registry_get_factory
+atk_get_default_registry
+<SUBSECTION Standard>
+ATK_REGISTRY
+ATK_IS_REGISTRY
+ATK_TYPE_REGISTRY
+ATK_REGISTRY_CLASS
+ATK_IS_REGISTRY_CLASS
+ATK_REGISTRY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atkrelation</FILE>
+AtkRelationType
+<TITLE>AtkRelation</TITLE>
+atk_relation_type_register
+atk_relation_new
+atk_relation_get_relation_type
+atk_relation_get_target
+<SUBSECTION Standard>
+ATK_RELATION
+ATK_IS_RELATION
+ATK_TYPE_RELATION
+atk_relation_get_type
+ATK_RELATION_CLASS
+ATK_IS_RELATION_CLASS
+ATK_RELATION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atkrelationset</FILE>
+<TITLE>AtkRelationSet</TITLE>
+atk_relation_set_new
+atk_relation_set_contains
+atk_relation_set_remove
+atk_relation_set_add
+atk_relation_set_get_n_relations
+atk_relation_set_get_relation
+atk_relation_set_get_relation_by_type
+<SUBSECTION Standard>
+ATK_RELATION_SET
+ATK_IS_RELATION_SET
+ATK_TYPE_RELATION_SET
+atk_relation_set_get_type
+ATK_RELATION_SET_CLASS
+ATK_IS_RELATION_SET_CLASS
+ATK_RELATION_SET_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atkselection</FILE>
+ATK_SELECTION_GET_IFACE
+AtkSelection
+AtkSelectionIface
+atk_selection_add_selection
+atk_selection_clear_selection
+atk_selection_ref_selection
+atk_selection_get_selection_count
+atk_selection_is_child_selected
+atk_selection_remove_selection
+atk_selection_select_all_selection
+<SUBSECTION Standard>
+ATK_SELECTION
+ATK_IS_SELECTION
+ATK_TYPE_SELECTION
+atk_selection_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atkstateset</FILE>
+<TITLE>AtkStateSet</TITLE>
+atk_state_set_new
+atk_state_set_is_empty
+atk_state_set_add_state
+atk_state_set_add_states
+atk_state_set_clear_states
+atk_state_set_contains_state
+atk_state_set_contains_states
+atk_state_set_remove_state
+atk_state_set_and_sets
+atk_state_set_or_sets
+atk_state_set_xor_sets
+<SUBSECTION Standard>
+ATK_STATE_SET
+ATK_IS_STATE_SET
+ATK_TYPE_STATE_SET
+atk_state_set_get_type
+ATK_STATE_SET_CLASS
+ATK_IS_STATE_SET_CLASS
+ATK_STATE_SET_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>atktable</FILE>
+ATK_TABLE_GET_IFACE
+AtkTable
+AtkTableIface
+atk_table_ref_at
+atk_table_get_index_at
+atk_table_get_row_at_index
+atk_table_get_column_at_index
+atk_table_get_caption
+atk_table_get_n_columns
+atk_table_get_column_description
+atk_table_get_column_extent_at
+atk_table_get_column_header
+atk_table_get_n_rows
+atk_table_get_row_description
+atk_table_get_row_extent_at
+atk_table_get_row_header
+atk_table_get_summary
+atk_table_get_selected_columns
+atk_table_get_selected_rows
+atk_table_is_column_selected
+atk_table_is_row_selected
+atk_table_is_selected
+atk_table_set_caption
+atk_table_set_column_description
+atk_table_set_column_header
+atk_table_set_row_description
+atk_table_set_row_header
+atk_table_set_summary
+<SUBSECTION Standard>
+ATK_TABLE
+ATK_IS_TABLE
+ATK_TYPE_TABLE
+atk_table_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atktext</FILE>
+ATK_TEXT_GET_IFACE
+AtkText
+AtkTextIface
+AtkTextBoundary
+atk_text_get_text
+atk_text_get_character_at_offset
+atk_text_get_text_after_offset
+atk_text_get_text_at_offset
+atk_text_get_text_before_offset
+atk_text_get_caret_offset
+atk_text_get_row_col_at_offset
+atk_text_get_range_attributes
+atk_text_get_character_extents
+atk_text_get_character_count
+atk_text_get_offset_at_point
+atk_text_get_selected_text
+atk_text_get_selection_bounds
+atk_text_set_selection_bounds
+atk_text_set_caret_offset
+<SUBSECTION Standard>
+ATK_TEXT
+ATK_IS_TEXT
+ATK_TYPE_TEXT
+atk_text_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atkvalue</FILE>
+ATK_VALUE_GET_IFACE
+AtkValue
+AtkValueIface
+atk_value_get_current_value
+atk_value_get_maximum_value
+atk_value_get_minimum_value
+atk_value_set_current_value
+<SUBSECTION Standard>
+ATK_VALUE
+ATK_IS_VALUE
+ATK_TYPE_VALUE
+atk_value_get_type
+</SECTION>
+
+<SECTION>
+<FILE>atk</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>atkstate</FILE>
+AtkStateType
+AtkState
+atk_state_type_register
+atk_state_type_get_name
+atk_state_type_for_name
+</SECTION>
+
+<SECTION>
+<FILE>atkutil</FILE>
+AtkFocusTracker
+AtkFocusTrackerInit
+atk_add_focus_tracker
+atk_remove_focus_tracker
+atk_focus_tracker_init
+atk_focus_tracker_notify
+</SECTION>
+