mirror of https://github.com/Icinga/icinga2.git
Documentation update.
This commit is contained in:
parent
ce60fbd6ba
commit
1584e03fa3
|
@ -21,13 +21,32 @@
|
|||
#define I2BASE_H
|
||||
|
||||
/**
|
||||
* @mainpage Foo
|
||||
* @mainpage Icinga Documentation
|
||||
*
|
||||
* Icinga implements a framework for run-time-loadable components which can
|
||||
* pass messages between them. These components can either be hosted in the
|
||||
* same process or in several host processes (either on the same machine or
|
||||
* on different machines).
|
||||
*
|
||||
* The framework's code critically depends on the following patterns:
|
||||
*
|
||||
* -Smart pointers
|
||||
*
|
||||
* The shared_ptr and weak_ptr template classes are used to simplify memory
|
||||
* management and to avoid accidental memory leaks and use-after-free bugs.
|
||||
*
|
||||
* -Observer pattern
|
||||
*
|
||||
* Framework classes expose events which other objects can subscribe to. This
|
||||
* is used to decouple clients of a class from the class' internal
|
||||
* implementation.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup base Base class library
|
||||
*
|
||||
* Hello World.
|
||||
* The base class library implements commonly-used functionality like
|
||||
* event handling for sockets and timers.
|
||||
*/
|
||||
|
||||
#ifdef _MSC_VER
|
||||
|
|
|
@ -22,6 +22,9 @@
|
|||
|
||||
/**
|
||||
* @defgroup icinga Icinga application
|
||||
*
|
||||
* The Icinga application is in charge of boot-strapping the Icinga
|
||||
* environment and loading additional components.
|
||||
*/
|
||||
|
||||
#include <i2-base.h>
|
||||
|
|
|
@ -22,6 +22,9 @@
|
|||
|
||||
/**
|
||||
* @defgroup jsonrpc JSON-RPC
|
||||
*
|
||||
* The JSON-RPC library implements server and client classes for the JSON-RPC
|
||||
* protocol.
|
||||
*/
|
||||
|
||||
#include <map>
|
||||
|
|
Loading…
Reference in New Issue