summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkdocument.sgml
diff options
context:
space:
mode:
authorAlejandro Piñeiro <apinheiro@igalia.com>2013-08-12 17:07:46 +0200
committerAlejandro Piñeiro <apinheiro@igalia.com>2013-08-12 21:06:36 +0200
commit0f1e31ad2451b1e00f631e217d9d29d306404f2d (patch)
tree9df22ec49c982912979aa6b907dd25dc27fccd96 /docs/tmpl/atkdocument.sgml
parentc568794a6f75cc9cc297b24978bc7480ee689bea (diff)
downloadatk-0f1e31ad2451b1e00f631e217d9d29d306404f2d.tar.gz
doc: removing several .sgml files and fixing gtk-doc warnings
The static documentation of those .sgml (so the reason of tracking those objects) where moved to the source files. Some other stuff was changed in order to prevent gtk-doc warnings (like replacing "Returns blah" for the correct "Returns: blah") https://bugzilla.gnome.org/show_bug.cgi?id=684665
Diffstat (limited to 'docs/tmpl/atkdocument.sgml')
-rw-r--r--docs/tmpl/atkdocument.sgml126
1 files changed, 0 insertions, 126 deletions
diff --git a/docs/tmpl/atkdocument.sgml b/docs/tmpl/atkdocument.sgml
deleted file mode 100644
index 935ac0c..0000000
--- a/docs/tmpl/atkdocument.sgml
+++ /dev/null
@@ -1,126 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-AtkDocument
-
-<!-- ##### SECTION Short_Description ##### -->
-The ATK interface which represents the toplevel container for document content.
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The AtkDocument interface should be supported by any object whose content is a
-representation or view of a document. The AtkDocument interface should appear
-on the toplevel container for the document content; however AtkDocument
-instances may be nested (i.e. an AtkDocument may be a descendant of another
-AtkDocument) in those cases where one document contains "embedded content"
-which can reasonably be considered a document in its own right.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT AtkDocument ##### -->
-<para>
-The AtkDocument structure does not contain any fields.
-
-
-</para>
-
-
-<!-- ##### SIGNAL AtkDocument::load-complete ##### -->
-<para>
-The 'load-complete' signal is emitted when a pending load of a static
-document has completed. This signal is to be expected by ATK clients
-if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state
-of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY,
-it should be safe for clients to assume that the AtkDocument's static contents
-are fully loaded into the container. (Dynamic document contents should
-be exposed via other signals.)
-</para>
-
-@atkdocument: the object which received the signal.
-
-<!-- ##### SIGNAL AtkDocument::load-stopped ##### -->
-<para>
-The 'load-stopped' signal is emitted when a pending load of document contents
-is cancelled, paused, or otherwise interrupted by the user or application
-logic. It should not however be
-emitted while waiting for a resource (for instance while blocking on a file or
-network read) unless a user-significant timeout has occurred.
-</para>
-
-@atkdocument: the object which received the signal.
-
-<!-- ##### SIGNAL AtkDocument::reload ##### -->
-<para>
-The 'reload' signal is emitted when the contents of a document is refreshed
-from its source. Once 'reload' has been emitted, a matching 'load-complete'
-or 'load-stopped' signal should follow, which clients may await before
-interrogating ATK for the latest document content.
-</para>
-
-@atkdocument: the object which received the signal.
-
-<!-- ##### FUNCTION atk_document_get_document_type ##### -->
-<para>
-
-</para>
-
-@document:
-@Returns:
-
-
-<!-- ##### FUNCTION atk_document_get_document ##### -->
-<para>
-
-</para>
-
-@document:
-@Returns:
-
-
-<!-- ##### FUNCTION atk_document_get_attribute_value ##### -->
-<para>
-
-</para>
-
-@document:
-@attribute_name:
-@Returns:
-
-
-<!-- ##### FUNCTION atk_document_set_attribute_value ##### -->
-<para>
-
-</para>
-
-@document:
-@attribute_name:
-@attribute_value:
-@Returns:
-
-
-<!-- ##### FUNCTION atk_document_get_attributes ##### -->
-<para>
-
-</para>
-
-@document:
-@Returns:
-
-
-<!-- ##### FUNCTION atk_document_get_locale ##### -->
-<para>
-
-</para>
-
-@document:
-@Returns:
-
-