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

doc: add lots of doxygen documentation
author David Demelier <markand@malikania.fr>
date Fri, 09 Nov 2018 13:31:00 +0100
parents
children 8460b4a34191
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/doxygen/mainpage.cpp	Fri Nov 09 13:31:00 2018 +0100
@@ -0,0 +1,32 @@
+/**
+ * \mainpage
+ *
+ * Welcome to the irccd C++ API.
+ *
+ * ## Introduction
+ *
+ * The irccd libraries let you create your own native plugins but also your own
+ * bot from scratch if you want.
+ *
+ * ## Libraries
+ *
+ * The irccd libraries are split and described as following:
+ *
+ * | Library       | Description                                     | Dependencies         |
+ * |---------------|-------------------------------------------------|----------------------|
+ * | libirccd-core | Common utilities                                | libjson              |
+ * | libirccd-ctl  | Classes to connect to irccd instance            | libirccd             |
+ * | libirccd-test | Tools to create unit tests                      | libirccd,libirccd-js |
+ * | libirccd-js   | Libraries to create Javascript APIs and plugins | libirccd, libduktape |
+ * | libirccd      | Everything related to irccd instance            | libirccd-core        |
+ *
+ * There is also external libraries shipped with irccd:
+ *
+ * | Library       | Description          | Link        |
+ * |---------------|----------------------|-------------|
+ * | libduktape    | Javascript engine    | [duktape][] |
+ * | libjson       | Niels Lohmanns' JSON | [json][]    |
+ *
+ * [duktape]: http://duktape.org
+ * [json]: https://github.com/nlohmann/json
+ */