toc for examples

Mon, 13 Nov 2017 15:54:17 +0100

author
Mike Becker <universe@uap-core.de>
date
Mon, 13 Nov 2017 15:54:17 +0100
changeset 266
33d229634809
parent 265
6769a888fd3f
child 267
f4789572c9d6

toc for examples

Doxyfile file | annotate | diff | comparison | revisions
docs/src/examples.md file | annotate | diff | comparison | revisions
docs/src/header.html file | annotate | diff | comparison | revisions
--- a/Doxyfile	Mon Nov 13 13:27:18 2017 +0100
+++ b/Doxyfile	Mon Nov 13 15:54:17 2017 +0100
@@ -1754,7 +1754,7 @@
 # classes and files.
 # The default value is: NO.
 
-GENERATE_MAN           = YES
+GENERATE_MAN           = NO
 
 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
--- a/docs/src/examples.md	Mon Nov 13 13:27:18 2017 +0100
+++ b/docs/src/examples.md	Mon Nov 13 15:54:17 2017 +0100
@@ -2,4 +2,45 @@
 title: Examples
 ---
 
-Examples are currently developed and will be available very soon.
+On this page you find several example use cases in which the UAP Common
+Extensions make life easier.
+The examples are ordered by the complexity of the problem and start with
+simple showcases.
+Finally, we show how to implement a simple [properties editor](#props) with UCX.
+
+<a name="sstr"></a>
+
+## String
+
+Coming soon...
+
+<a name="list"></a>
+
+## List
+
+Coming soon...
+
+<a name="mpool"></a>
+
+## Memory Pool
+
+Coming soon...
+
+<a name="buffer"></a>
+
+## Buffer
+
+Coming soon...
+
+<a name="tests"></a>
+
+## Testing
+
+Coming soon...
+
+<a name="props"></a>
+
+## Properties Editor
+
+Coming soon...
+
--- a/docs/src/header.html	Mon Nov 13 13:27:18 2017 +0100
+++ b/docs/src/header.html	Mon Nov 13 15:54:17 2017 +0100
@@ -34,7 +34,16 @@
                         <li><a href="modules.html#utils">Utilities</a></li>
                     </ul>
                     </li>
-                    <li><a href="examples.html">Examples</a></li>
+                    <li><a href="examples.html">Examples</a>
+                    <ul>
+                        <li><a href="examples.html#sstr">String</a></li>
+                        <li><a href="examples.html#list">List</a></li>
+                        <li><a href="examples.html#mpool">Memory Pool</a></li>
+                        <li><a href="examples.html#buffer">Buffer</a></li>
+                        <li><a href="examples.html#tests">Testing</a></li>
+                        <li><a href="examples.html#props">Properties Editor</a></li>
+                    </ul>
+                    </li>
                 </ul>
             </div>
             <div class="nav">

mercurial