[libgdata] docs: Add a diagram of cancellation in libgdata
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgdata] docs: Add a diagram of cancellation in libgdata
- Date: Thu, 16 Dec 2010 12:47:14 +0000 (UTC)
commit b1f7f3fd54a155889939c5bbcafe711e072406e9
Author: Philip Withnall <philip tecnocode co uk>
Date: Thu Dec 16 12:45:46 2010 +0000
docs: Add a diagram of cancellation in libgdata
docs/reference/Makefile.am | 7 +++++--
docs/reference/cancellation.dia | Bin 0 -> 1273 bytes
docs/reference/cancellation.png | Bin 0 -> 7849 bytes
docs/reference/gdata-overview.xml | 8 ++++++++
4 files changed, 13 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 287e757..6fd70f6 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -66,8 +66,10 @@ IGNORE_HFILES = \
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES = \
- structure.png \
- data-flow.png
+ structure.png \
+ data-flow.png \
+ cancellation.png \
+ $(NULL)
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
@@ -109,6 +111,7 @@ EXTRA_DIST += \
version.xml.in \
structure.dia \
data-flow.dia \
+ cancellation.dia \
$(NULL)
if ENABLE_GTK_DOC
diff --git a/docs/reference/cancellation.dia b/docs/reference/cancellation.dia
new file mode 100644
index 0000000..3595787
Binary files /dev/null and b/docs/reference/cancellation.dia differ
diff --git a/docs/reference/cancellation.png b/docs/reference/cancellation.png
new file mode 100644
index 0000000..62b8d44
Binary files /dev/null and b/docs/reference/cancellation.png differ
diff --git a/docs/reference/gdata-overview.xml b/docs/reference/gdata-overview.xml
index f9a9bb8..eb274e3 100644
--- a/docs/reference/gdata-overview.xml
+++ b/docs/reference/gdata-overview.xml
@@ -166,6 +166,14 @@
<para>This may be useful in situations where the user is cancelling an operation due to it taking too long; the application
using libgdata may want to make use of the result of the operation, even if it has previously tried to cancel the
operation after network activity finished.</para>
+ <para>The behaviour of cancellation in libgdata can be represented as follows:
+ <figure>
+ <mediaobject>
+ <imageobject><imagedata fileref="cancellation.png" format="PNG" align="center"/></imageobject>
+ </mediaobject>
+ <textobject><phrase>The behaviour of cancellation in libgdata.</phrase></textobject>
+ </figure>
+ </para>
</refsect2>
</refsect1>
</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]