librnr  1.14.5
RoadNarrows Robotics Common Library 1
examples.doxy
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // Package: RoadNarrows Robotics Common Library 1
4 //
5 // File: examples.doxy
6 //
7 // Description:
8 // This file contains the doxygen directives to generate the examples
9 // pages found in the "Related Pages" document section.
10 //
11 ////////////////////////////////////////////////////////////////////////////////
12 
13 /*! \file */
14 
15 /*!
16  * \page example_assoc example_assoc
17  * This example_assoc page provides an example of librnr support for simple
18  * associative mapping.
19  *
20  * \section example_assoc_c Example main():
21  * configuration databases.
22  * \include examples/example_assoc.c
23  *
24  * \section example_assoc_run Generated output:
25  * \include example_assoc.run
26  */
27 
28 /*!
29  * \page example_checksum example_checksum
30  * This example_checksum page provides an example of librnr support for
31  * various checksum algorithms.
32  *
33  * \section example_checksum_c Example main():
34  * \include example_checksum.c
35  */
36 
37 /*!
38  * \page example_config example_config
39  * This example_config page provides an example of librnr support for
40  * configuration parsing and database access.
41  *
42  * \section example_config_c Example main():
43  * This example provides a simple shell to create, modify, and delete
44  * configuration databases.
45  * \include example_config.c
46  *
47  * \section example_config_ini Configuration input file:
48  * \include example.ini
49  *
50  * \section example_config_run Generated output:
51  * \include example_config.run
52  */
53 
54 /*!
55  * \page example_cpp example_cpp
56  * This example_cpp page provides an example of compiling and linking C++
57  * application against librnr.
58  *
59  * \section example_cpp_cxx Example main():
60  * configuration databases.
61  * \include examples/example_cpp.cxx
62  */
63 
64 /*!
65  * \page example_dlist example_dlist
66  * This example_dlist page shows how to "derive" and use a doubly-linked list
67  * using the librnr dlistvoid.h header file and the library functions
68  * DListVoid<<em>x</em>> defined in dlistvoid.c.
69  *
70  *
71  * \section example_dlist_h Example header file:
72  * \include example_dlist.h
73  *
74  * \section example_dlist_c Example main():
75  * \include example_dlist.c
76  *
77  * \section example_dlist_run Generated output:
78  * \include example_dlist.run
79  */
80 
81 /*!
82  * \page example_hash example_hash
83  * This example_hash page provides an example of librnr support for hashing.
84  *
85  * \section example_hash_c Example main():
86  * This example is a modified version of the unit test code writen by
87  * Kaz Kylheku (kaz@ashi.footprints.net), (C) 1997.
88  * See also the original EULA in hash.h.
89  * \include example_hash.c
90  *
91  * \section example_hash_run Generated output:
92  * \include example_hash.run
93  */
94 
95 /*!
96  * \page example_log example_log
97  * This example_log page provides an example of librnr support for logging and
98  * command-line options processing.
99  *
100  * \section example_log_c Example main():
101  * \include example_log.c
102  *
103  * \section example_log_run1 Generated output for run #1:
104  * \include example_log.run1
105  *
106  * \section example_log_run2 Generated output for run #2:
107  * \include example_log.run2
108  */
109 
110 /*!
111  * \page example_shm example_shm
112  * This example_shm page provides an example of librnr support for
113  * shared memory.
114  *
115  * \section example_shm_c Example main():
116  * \include example_shm.c
117  */
118 
119 /*!
120  * \page example_uri example_uri
121  * This example_uri page provides an example of librnr support for Uniform
122  * Resource Identifier (URI) parsing.
123  *
124  * \section example_uri_c Example main():
125  * \include example_uri.c
126  */