[kde-doc-english] [rocs] doc: Remove vanished data structures.
Andreas Cord-Landwehr
cordlandwehr at kde.org
Mon Nov 10 22:08:59 UTC 2014
Git commit 5975c10b7bd55fc0804bed6d9e1414ad74d4fab0 by Andreas Cord-Landwehr.
Committed on 10/11/2014 at 21:02.
Pushed by cordlandwehr into branch 'master'.
Remove vanished data structures.
D +0 -143 doc/apiLinkedListstructure.docbook
D +0 -62 doc/apiRootedTreestructure.docbook
M +0 -6 doc/index.docbook
http://commits.kde.org/rocs/5975c10b7bd55fc0804bed6d9e1414ad74d4fab0
diff --git a/doc/apiLinkedListstructure.docbook b/doc/apiLinkedListstructure.docbook
deleted file mode 100644
index 279050a..0000000
--- a/doc/apiLinkedListstructure.docbook
+++ /dev/null
@@ -1,143 +0,0 @@
-<sect1>
-<title>Scripting API for Linked List Backend</title>
-<sect2>
-<title>Linked List Data Structure</title>
-<para>
-A list objects holds the information of a data structure of type <quote>Linked List</quote>.
-</para>
-
-<sect3>
-<title>Properties</title>
-<itemizedlist>
- <listitem>
- <para>
- <emphasis>name</emphasis> :
- </para>
- <para>The unique name of this data structure.</para>
- </listitem>
-</itemizedlist>
-</sect3>
-
-
-<sect3>
-<title>Methods</title>
-<variablelist>
-
- <varlistentry>
- <term>head()</term>
- <listitem>
- <para>Return head node of the list.</para>
- <funcsynopsis><funcprototype>
- <funcdef>ListNode <function>head</function></funcdef>
- <paramdef></paramdef>
- </funcprototype>
- </funcsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>setHead(node)</term>
- <listitem>
- <para>Set the head of the list.</para>
- <funcsynopsis><funcprototype>
- <funcdef>void <function>setHead</function></funcdef>
- <paramdef>ListNode <parameter><replaceable>node</replaceable></parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>createNode(type)</term>
- <listitem>
- <para>Create a new node of the specified type and return the created node. If the type is not registered, no node is created.</para>
- <funcsynopsis><funcprototype>
- <funcdef>ListNode <function>createNode</function></funcdef>
- <paramdef>int <parameter><replaceable>type</replaceable></parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>createNode()</term>
- <listitem>
- <para>Create a new node of default type and return the created node.</para>
- <funcsynopsis><funcprototype>
- <funcdef>ListNode <function>createNode</function></funcdef>
- <paramdef></paramdef>
- </funcprototype>
- </funcsynopsis>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect3>
-</sect2>
-
-
-<sect2>
-<title>List Node</title>
-<para>
-A node is the data element of a linked list.
-</para>
-
-<sect3>
-<title>Properties</title>
-<itemizedlist>
-
- <listitem>
- <para>
- <emphasis>width</emphasis> :
- </para>
- <para>The size of this data element.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>x</emphasis> :
- </para>
- <para>The x-coordinate of this data element.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>y</emphasis> :
- </para>
- <para>The y-coordinate of this data element.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>id</emphasis> :
- </para>
- <para>The unique identifier of this data element.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>color</emphasis> :
- </para>
- <para>The color of this data element stated as hexadecimal value.</para>
- </listitem>
-</itemizedlist>
-</sect3>
-
-
-<sect3>
-<title>Methods</title>
-<variablelist>
- <varlistentry>
- <term>pointTo(target)</term>
- <listitem>
- <para>Set pointer of this list node to the target node.</para>
- <funcsynopsis><funcprototype>
- <funcdef>void <function>pointTo</function></funcdef>
- <paramdef>ListNode <parameter><replaceable>target</replaceable></parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </listitem>
- </varlistentry>
-</variablelist>
-</sect3>
-</sect2>
-</sect1>
diff --git a/doc/apiRootedTreestructure.docbook b/doc/apiRootedTreestructure.docbook
deleted file mode 100644
index 957b5d6..0000000
--- a/doc/apiRootedTreestructure.docbook
+++ /dev/null
@@ -1,62 +0,0 @@
-<sect1 id="scripting-backend-rootedtree">
-<title>Scripting API for Rooted Tree Backend</title>
-<sect2>
-<title>Rooted Tree Data Structure</title>
-<para>
- The data structure properties dialog allows access to configure settings specific to the Graph backend.
- There, by checking the <guilabel>Show all pointers</guilabel> property, all pointers between the tree nodes are shown.
- If unchecked, multiple pointers between same nodes are collapsed to one.
-</para>
-</sect2>
-
-<sect2>
-<title>The Rooted Tree Structure</title>
-<para>
-Given a data structure object of type "Rooted Tree", the following properties can be read or written:
-</para>
-<programlisting>
- ShowAllPointers // set to true if show all edges, set to false if multiple edges shall be compressed
-</programlisting>
-<para>
-Given a data structure object of type "Rooted Tree", you can call the following member functions:
-</para>
-<programlisting>
- node add_data(string name); // add a node to tree with given name
- void set_root_node(node root); // set root as root node of the tree
- node root_node(); // return root node of the tree
-</programlisting>
-</sect2>
-
-<sect2>
-<title>Rooted Tree Nodes</title>
-<para>
-Given a node object of type "Rooted Tree", the following properties can be read or written:
-</para>
-<programlisting>
- int numberOfChilds // set the number of (allowed) children for this node
- node left_child // read only: node that is the left child
- node right_child // read only: node that is the right child
- node node_parent // read only: node that is the parent
-</programlisting>
-<para>
-Given a node object of type "Rooted Tree", you can call the following member functions:
-</para>
-<programlisting>
- node add_left_child(node child); // add left child
- node add_right_child(node child); // add right child
- node add_child(node child, int i); // add a child as the i-th child of the node
- node add_node_parent(node child); // add parent (only successful if no parent set, yet)
- node left_child(); // return right child
- node right_child(); // return left child
- node child_at(int i); // return the i-th child of the node
- node node_parent(); // return the node's parent
-</programlisting>
-</sect2>
-
-<sect2>
-<title>Rooted Tree Edges</title>
-<para>
-Given edges of a data structure of type "Rooted Tree", only the properties of the base data structure are available.
-</para>
-</sect2>
-</sect1>
diff --git a/doc/index.docbook b/doc/index.docbook
index a22ef93..a184524 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -9,8 +9,6 @@
<!ENTITY apiConsole SYSTEM "apiConsole.docbook">
<!ENTITY apiDatastructure SYSTEM "apiDatastructure.docbook">
<!ENTITY apiGraphstructure SYSTEM "apiGraphstructure.docbook">
- <!ENTITY apiLinkedListstructure SYSTEM "apiLinkedListstructure.docbook">
- <!ENTITY apiRootedTreestructure SYSTEM "apiRootedTreestructure.docbook">
<!ENTITY chapterImportExport SYSTEM "chapterImportExport.docbook">
]>
@@ -610,10 +608,6 @@ But also every backend provides the properties and functions that are defined fo
&apiGraphstructure;
-&apiLinkedListstructure;
-
-&apiRootedTreestructure;
-
&apiConsole;
</chapter>
More information about the kde-doc-english
mailing list