summaryrefslogtreecommitdiffstats
path: root/docs/raptor-tutorial-intro.xml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:40:05 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:40:05 +0000
commit4038ab95a094b363f1748f3dcb51511a1217475d (patch)
tree7f393d66a783f91ddd263c78d681e485cf4f45ca /docs/raptor-tutorial-intro.xml
parentInitial commit. (diff)
downloadraptor2-4038ab95a094b363f1748f3dcb51511a1217475d.tar.xz
raptor2-4038ab95a094b363f1748f3dcb51511a1217475d.zip
Adding upstream version 2.0.16.upstream/2.0.16upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/raptor-tutorial-intro.xml')
-rw-r--r--docs/raptor-tutorial-intro.xml25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/raptor-tutorial-intro.xml b/docs/raptor-tutorial-intro.xml
new file mode 100644
index 0000000..58640bb
--- /dev/null
+++ b/docs/raptor-tutorial-intro.xml
@@ -0,0 +1,25 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<chapter id="tutorial-initialising-finishing">
+<title>Initialising and Finishing using the Library</title>
+
+<para>Raptor requires initialising a raptor_world object before using
+any of the classes which take the world object as an argument in
+their constructors. The function to make the world object is
+raptor_new_world() and the destructor raptor_free_world().
+<programlisting>
+ raptor_world* world;
+ world = raptor_new_world();
+ ...
+ raptor_free_world(world);
+</programlisting>
+</para>
+
+</chapter>
+
+<!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("raptor-docs.xml" "book" "part")
+End:
+-->