[libgda] Added UML diagrams to classes and Record class documentation
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda] Added UML diagrams to classes and Record class documentation
- Date: Tue, 27 Mar 2012 01:09:51 +0000 (UTC)
commit 9b73d427ee5c647e55c7901af8f49f20bedf06ca
Author: Daniel Espinosa <despinosa src gnome org>
Date: Mon Mar 26 19:08:45 2012 -0600
Added UML diagrams to classes and Record class documentation
doc/mallard/gda-data/Classes.page | 7 +++++--
doc/mallard/gda-data/Record-Class.page | 8 ++++++++
doc/mallard/gda-data/classes-uml.png | Bin 0 -> 26915 bytes
doc/mallard/gda-data/interfaces-uml.png | Bin 35566 -> 35653 bytes
doc/mallard/gda-data/record-class-uml.png | Bin 0 -> 12398 bytes
5 files changed, 13 insertions(+), 2 deletions(-)
---
diff --git a/doc/mallard/gda-data/Classes.page b/doc/mallard/gda-data/Classes.page
index 8d667fa..e72e55b 100644
--- a/doc/mallard/gda-data/Classes.page
+++ b/doc/mallard/gda-data/Classes.page
@@ -22,6 +22,9 @@
<p>
They load in memory all required data from database when <code>update()</code> method is called; but you are able to set data without call it and then use <code>save()</code> method to set it to the database. Methods <code>update()</code> and <code>save()</code> execute SQL commands directly using GDA's database providers.
</p>
- <p>
- </p>
+ <figure>
+ <title>UML diagram for Classes</title>
+ <desc>This diagram describes the available classes, its relations and interface implementations.</desc>
+ <media type="image" mime="image/png" src="classes-uml.png"/>
+</figure>
</page>
diff --git a/doc/mallard/gda-data/Record-Class.page b/doc/mallard/gda-data/Record-Class.page
index 2f985e3..a508ee6 100644
--- a/doc/mallard/gda-data/Record-Class.page
+++ b/doc/mallard/gda-data/Record-Class.page
@@ -22,6 +22,14 @@
<p>
In order to load data, you need to set a table and a key. Then <code>update()</code> method execute a SELECT command using the key to find the required row in the table.
</p>
+ <section id="record-uml">
+ <title>Record class UML definition</title>
+ <figure>
+ <title>UML definition</title>
+ <desc>This diagram describes Record class and its implementations.</desc>
+ <media type="image" mime="image/png" src="record-class-uml.png"/>
+</figure>
+ </section>
<section id="record-update">
<title>Using a Record class to access a row in a table</title>
<listing>
diff --git a/doc/mallard/gda-data/classes-uml.png b/doc/mallard/gda-data/classes-uml.png
new file mode 100644
index 0000000..43f0820
Binary files /dev/null and b/doc/mallard/gda-data/classes-uml.png differ
diff --git a/doc/mallard/gda-data/interfaces-uml.png b/doc/mallard/gda-data/interfaces-uml.png
index e41b871..0eafede 100644
Binary files a/doc/mallard/gda-data/interfaces-uml.png and b/doc/mallard/gda-data/interfaces-uml.png differ
diff --git a/doc/mallard/gda-data/record-class-uml.png b/doc/mallard/gda-data/record-class-uml.png
new file mode 100644
index 0000000..b577ae7
Binary files /dev/null and b/doc/mallard/gda-data/record-class-uml.png differ
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]