grim/purple-objects-docbook

3d85aaf3ca93
Parents 4608408a1f6f
Children 96f4c487e144
new graphs for PurplePlugin and PurplePluginState
start of the plugins section
--- a/Makefile Fri Apr 17 20:17:43 2009 -0500
+++ b/Makefile Fri Apr 17 21:03:11 2009 -0500
@@ -7,12 +7,15 @@
BOOK_SOURCES=\
about.xml \
graphs.xml \
+ plugins.xml \
purple-objects.xml
IMAGES=\
object-key.png \
+ plugin-class.png \
plugin-objects.png \
plugin-loader-objects.png \
+ plugin-state.png \
relationship-key.png
all: book.stamp images.stamp
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/plugin-class.dot Fri Apr 17 21:03:11 2009 -0500
@@ -0,0 +1,8 @@
+/*
+ vi: syntax=dot:wrap
+*/
+digraph {
+ node[fontname="sans", fontsize="9", shape="record", style="filled", fillcolor="lightyellow"];
+ class[label="{PurplePlugin|-\ state\ :\ PurplePluginState\l|-\ filename\ :\ gchar\ *\l|-\ info\ :\ PurplePluginInfo\l|+\ purple_plugin_get_filename(plugin\ :\ const\ PurplePlugin\ *)\ :\ const\ gchar\ *\l|+\ purple_plugin_get_info(plugin\ :\ const\ PurplePlugin\ *)\ :\ PurplePluginInfo\ *\l|+\ purple_plugin_get_state(plugin\ :\ const PurplePlugin\ *)\ :\ PurplePluginState\l}"];
+}
+
--- a/plugin-objects.fdp Fri Apr 17 20:17:43 2009 -0500
+++ b/plugin-objects.fdp Fri Apr 17 21:03:11 2009 -0500
@@ -8,7 +8,7 @@
overlap=FALSE;
rankdir="tb";
- node[fontname="sans", fontsize="8", style="filled", shape="rect"];
+ node[fontname="sans", fontsize="9", style="filled", shape="rect"];
/* abstract classes */
node[fillcolor="palegreen"];
@@ -21,12 +21,13 @@
/* concrete classes */
node[fillcolor="lightpink"];
+ PurplePluginInfo;
PurpleNativePlugin;
PurplePerlPlugin;
PurpleTCLPlugin;
PurpleMonoPlugin;
- /* associations */
+ /* inheritance */
PurpleObject -> GObject;
PurplePlugin -> PurpleObject;
@@ -35,5 +36,9 @@
PurplePerlPlugin -> PurplePlugin;
PurpleTCLPlugin -> PurplePlugin;
PurpleMonoPlugin -> PurplePlugin;
+
+ /* has-a's */
+ edge[arrowhead="odiamond"];
+ PurplePlugin -> PurplePluginInfo;
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/plugin-state.dot Fri Apr 17 21:03:11 2009 -0500
@@ -0,0 +1,8 @@
+/*
+ vi: syntax=dot:wrap
+*/
+digraph {
+ node[fontname="sans", fontsize="9", shape="record", style="filled", fillcolor="lightyellow"];
+ class[label="{PurplePluginState\n\<\<\ enumeration\ \>\>|PURPLE_PLUGIN_STATE_UNKNOWN\ :\ -1\l|PURPLE_PLUGIN_STATE_ERROR\ :\ 0\l|PURPLE_PLUGIN_STATE_LOADED\l|PURPLE_PLUGIN_STATE_LOAD_FAILED\l|PURPLE_PLUGIN_STATE_NOT_LOADED\l|PURPLE_PLUGIN_STATES\l}"];
+}
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/plugins.xml Fri Apr 17 21:03:11 2009 -0500
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<refentry id="plugins">
+ <refmeta>
+ <refentrytitle>Plugins</refentrytitle>
+ </refmeta>
+
+ <refsect1>
+ <title>Plugins</title>
+
+ <para>
+
+ </para>
+ </refsect1>
+</refentry>
+