[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [rocs] RocsCore/DataStructures/LinkedList: Add API for linked list data structure.
From:       Andreas Cord-Landwehr <cordlandwehr () kde ! org>
Date:       2013-05-21 19:26:12
Message-ID: 20130521192612.89466A607F () git ! kde ! org
[Download RAW message or body]

Git commit bd16971a43ebff17add77c2d858e624ae44b926e by Andreas Cord-Landwehr.
Committed on 21/05/2013 at 21:12.
Pushed by cordlandwehr into branch 'master'.

Add API for linked list data structure.

M  +2    -0    RocsCore/DataStructures/LinkedList/CMakeLists.txt
A  +30   -0    RocsCore/DataStructures/LinkedList/ListNode.xml
A  +62   -0    RocsCore/DataStructures/LinkedList/ListStructure.xml

http://commits.kde.org/rocs/bd16971a43ebff17add77c2d858e624ae44b926e

diff --git a/RocsCore/DataStructures/LinkedList/CMakeLists.txt \
b/RocsCore/DataStructures/LinkedList/CMakeLists.txt index e13ffd2..2ae4930 100644
--- a/RocsCore/DataStructures/LinkedList/CMakeLists.txt
+++ b/RocsCore/DataStructures/LinkedList/CMakeLists.txt
@@ -53,6 +53,8 @@ target_link_libraries(rocs_ListStructure
 install(TARGETS rocs_ListStructure  DESTINATION ${PLUGIN_INSTALL_DIR})
 
 install(FILES  rocs_ListStructure.desktop  DESTINATION ${SERVICES_INSTALL_DIR})
+install(FILES ListStructure.xml DESTINATION ${DATA_INSTALL_DIR}/rocs/engineapi)
+install(FILES ListNode.xml DESTINATION ${DATA_INSTALL_DIR}/rocs/engineapi)
 
 if(KDE4_BUILD_TESTS)
     enable_testing()
diff --git a/RocsCore/DataStructures/LinkedList/ListNode.xml \
b/RocsCore/DataStructures/LinkedList/ListNode.xml new file mode 100644
index 0000000..6ea9e28
--- /dev/null
+++ b/RocsCore/DataStructures/LinkedList/ListNode.xml
@@ -0,0 +1,30 @@
+<object inherit="Data">
+<name>List Node</name>
+<id>ListNode</id>
+<componentType>Data</componentType>
+<description>
+<para>
+A node is the data element of a linked list.
+</para>
+</description>
+<syntax>
+</syntax>
+<properties>
+</properties>
+<methods>
+<method>
+    <name>pointTo(target)</name>
+    <description>
+        <para>Set pointer of this list node to the target node.</para>
+    </description>
+    <returnType>void</returnType>
+    <parameters>
+        <parameter>
+            <name>target</name>
+            <type>ListNode</type>
+            <info>Target node.</info>
+        </parameter>
+    </parameters>
+</method>
+</methods>
+</object>
diff --git a/RocsCore/DataStructures/LinkedList/ListStructure.xml \
b/RocsCore/DataStructures/LinkedList/ListStructure.xml new file mode 100644
index 0000000..fc52a8e
--- /dev/null
+++ b/RocsCore/DataStructures/LinkedList/ListStructure.xml
@@ -0,0 +1,62 @@
+<object inherit="DataStructure">
+<name>Linked List Data Structure</name>
+<id>ListStructure</id>
+<componentType>DataStructure</componentType>
+<description>
+<para>
+A list objects holds the information of a data structure of type "Linked List".
+</para>
+</description>
+<syntax>
+</syntax>
+<properties>
+</properties>
+<methods>
+<method>
+    <name>head()</name>
+    <description>
+        <para>Return head node of the list.</para>
+    </description>
+    <returnType>ListNode</returnType>
+    <parameters>
+    </parameters>
+</method>
+<method>
+    <name>setHead(node)</name>
+    <description>
+        <para>Set the head of the list.</para>
+    </description>
+    <returnType>void</returnType>
+    <parameters>
+        <parameter>
+            <name>node</name>
+            <type>ListNode</type>
+            <info>Node that shall become head of the list.</info>
+        </parameter>
+    </parameters>
+</method>
+<method>
+    <name>createNode(type)</name>
+    <description>
+        <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> +    </description>
+    <returnType>ListNode</returnType>
+    <parameters>
+        <parameter>
+            <name>type</name>
+            <type>int</type>
+            <info>Identifier of a data type.</info>
+        </parameter>
+    </parameters>
+</method>
+<method>
+    <name>createNode()</name>
+    <description>
+        <para>Create a new node of default type and return the created node.</para>
+    </description>
+    <returnType>ListNode</returnType>
+    <parameters>
+    </parameters>
+</method>
+</methods>
+</object>


[prev in list] [next in list] [prev in thread] [next in thread]