Mercurial > irccd

annotate doc/doxygen/mainpage.cpp @ 789:17367b6a99b4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: add lots of doxygen documentation
author David Demelier <markand@malikania.fr>
date Fri, 09 Nov 2018 13:31:00 +0100
parents
children 8460b4a34191
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
789
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /**
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * \mainpage
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Welcome to the irccd C++ API.
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * ## Introduction
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * The irccd libraries let you create your own native plugins but also your own
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 * bot from scratch if you want.
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * ## Libraries
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * The irccd libraries are split and described as following:
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * | Library | Description | Dependencies |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * |---------------|-------------------------------------------------|----------------------|
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 * | libirccd-core | Common utilities | libjson |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 * | libirccd-ctl | Classes to connect to irccd instance | libirccd |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 * | libirccd-test | Tools to create unit tests | libirccd,libirccd-js |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 * | libirccd-js | Libraries to create Javascript APIs and plugins | libirccd, libduktape |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 * | libirccd | Everything related to irccd instance | libirccd-core |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * There is also external libraries shipped with irccd:
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 * | Library | Description | Link |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 * |---------------|----------------------|-------------|
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 * | libduktape | Javascript engine | [duktape][] |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 * | libjson | Niels Lohmanns' JSON | [json][] |
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 *
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 * [duktape]: http://duktape.org
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 * [json]: https://github.com/nlohmann/json
17367b6a99b4 doc: add lots of doxygen documentation
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 */