Proton  1.1.1
Make porting easy from Python to C++11
mainpage.hpp
1 /** @mainpage C++11 Proton Library
2 *
3 * @authors <a href="http://lenx.100871.net">Lenx Tao Wei</a> (lenx.wei at gmail.com)
4 *
5 * @section intro Introduction
6 * Proton is a library to provide Python-like interfaces for C++11,
7 * which try to make porting from Python to C++11 easier,
8 * and make programming in C++11 more convenient :)
9 *
10 * The main git repository is at https://github.com/LenxWei/libproton.
11 *
12 * @section install Install
13 * Download site:
14 * - http://code.google.com/p/libproton/downloads/list
15 * - https://github.com/LenxWei/libproton/downloads
16 *
17 * Need a compiler supporting c++11, such as gcc 4.7.0 or higher.<br>
18 * Install <a href="http://www.boost.org/">Boost C++ Library</a> 1.48 or higher first.
19 *
20 * After that, just standard "./configure; make; make check; make install"
21 *
22 * @section modules Modules
23 * You can find documents about modules <a href="modules.html">here</a>.
24 * <hr>
25 * @todo 1.1.2 goal: list_, unordered_
26 * @todo add tutorial
27 * @todo 1.2 milestone
28 * @todo add os module
29 * @todo add socket module(?)
30 * @todo add server/client module
31 * @todo add regex module
32 * @todo add threading
33 * @todo 1.4 milestone
34 * @todo add gc support
35 * @todo 1.6 milestone
36 *
37 * @defgroup ref Smart reference
38 * Provide basic reference support for proton.
39 * @{
40 * @defgroup ref_ ref_
41 * Core reference template supporting interface through inheritance/multiple inheritance.
42 *
43 * @defgroup functor func_
44 * General functor interface template.
45 *
46 * @}
47 *
48 * @defgroup stl Containers
49 * Repack stl containers in new templates following python's habits.
50 * @{
51 * @defgroup seq common
52 * common container operations
53 *
54 * @defgroup str str
55 * like string in python.
56 *
57 * @defgroup vector_ vector_
58 * like list in python, better for small sequences
59 *
60 * @defgroup deque_ deque_
61 * like list in python, better for long sequences.
62 *
63 * @defgroup map_ map_
64 * like dict in python.
65 *
66 * @defgroup set_ set_
67 * like set in python.
68 *
69 * @defgroup tuple tuple
70 * like tuple in python.
71 *
72 * @}
73 *
74 * @defgroup util Utilities
75 * @{
76 *
77 * @defgroup getopt getopt
78 * get options
79 *
80 * @defgroup debug Debug utilities
81 * Macros, global variables, classes for debug.
82 *
83 * @defgroup pool Smart allocator
84 * A high-performance and smart allocator.
85 *
86 * @}
87 *
88 */