]> rtime.felk.cvut.cz Git - ulut.git/blob - doc/srcdoc/ulut.tmpl
Included documentation for uLUt library.
[ulut.git] / doc / srcdoc / ulut.tmpl
1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[]>
2
3 <book id="ULUTlibrary">
4  <bookinfo>
5   <title>uLan Utilities Library (ULUT)</title>
6   
7   <authorgroup>
8    <author>
9     <firstname>Pavel</firstname>
10     <surname>Pisa</surname>
11     <affiliation>
12      <address>
13       <email>pisa@cmp.felk.cvut.cz</email>
14      </address>
15     </affiliation>
16    </author>
17   </authorgroup>
18
19   <copyright>
20    <year>2003-2006</year>
21    <holder>Pavel Pisa</holder>
22   </copyright>
23
24   <abstract>
25    <para>The ULUT library contains useful constructions
26     and functions commonly used in "C" language programs.
27     It tries to be something like STL library is for the C++ programs,
28     but is is fall less simpler and powerful. It has small memory 
29     footprint and could be used even for small embedded applications.
30     Basic functionalities provided by library are more types of containers
31     (list, AVL tree, priority queue, heap-tree, etc..), timer framework
32     and event connectors.
33    </para>
34   </abstract>
35
36  </bookinfo>
37
38  <toc></toc>
39
40  <chapter id="funcdes">
41   <title>Functions Description</title>
42   <sect1><title>Generic AVL tree</title>
43 !F../../ulut/ul_gavl.h
44 !F../../ulut/ul_gavlprim.c
45 !F../../ulut/ul_gavl.c
46 <!--
47  F../../ulut/ul_gavlcust.h
48  F../../ulut/ul_gavlrepcust.h
49  F../../ulut/ul_gavlflesint.h
50  -->
51   </sect1>
52   <sect1><title>Hierarchical Timer Framework</title>
53 !F../../ulut/ul_htimer.h
54 <!--F../../ulut/ul_htimer.c-->
55 <!--F../../ulut/ul_htimmstime.c-->
56   </sect1>
57   <sect1><title>Generic Sorted Arrays</title>
58 !F../../ulut/ul_gsa.h
59 !F../../ulut/ul_gsa.c
60 <!--F../../ulut/ul_gsacust.h -->
61   </sect1>
62   <sect1><title>Bidirectional Linked List</title>
63 !F../../ulut/ul_listbase.h
64   </sect1>
65   <sect1><title>Dynamic Buffers</title>
66 !F../../ulut/ul_dbuff.h
67 !F../../ulut/ul_dbufbase.c
68 !F../../ulut/ul_dbufmore.c
69   </sect1>
70   <sect1><title>Event Connectors</title>
71 !F../../ulut/ul_evcbase.h
72 !F../../ulut/ul_evcbase.c
73   </sect1>
74   <sect1><title>Application Messages Logging</title>
75 !F../../ulut/ul_logbase.h
76 !F../../ulut/ul_logbase.c
77 <!--F../../ulut/ul_log.h-->
78   </sect1>
79   <sect1><title>Unique IDs Generator</title>
80 !F../../ulut/ul_uniqid.h
81 !F../../ulut/ul_uniqid.c
82   </sect1>
83  </chapter>
84 </book>