some doc updates
This commit is contained in:
parent
bba2d883b6
commit
5bea92d2a4
@ -4,6 +4,7 @@ API
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
:maxdepth: 4
|
||||||
|
|
||||||
|
api/cfdp
|
||||||
api/objectmanager
|
api/objectmanager
|
||||||
api/task
|
api/task
|
||||||
api/ipc
|
api/ipc
|
||||||
|
8
docs/api/cfdp.rst
Normal file
8
docs/api/cfdp.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
CFDP API
|
||||||
|
=================
|
||||||
|
|
||||||
|
``UserBase``
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. doxygenclass:: cfdp::UserBase
|
||||||
|
:members:
|
@ -7,12 +7,14 @@ Structure
|
|||||||
----------
|
----------
|
||||||
|
|
||||||
The general structure is driven by the usage of interfaces provided by objects.
|
The general structure is driven by the usage of interfaces provided by objects.
|
||||||
The FSFW uses C++11 as baseline. The intention behind this is that this C++ Standard should be
|
The FSFW uses C++17 as baseline.
|
||||||
widely available, even with older compilers.
|
It also uses dynamic allocation during the initialization but provides
|
||||||
The FSFW uses dynamic allocation during the initialization but provides static containers during runtime.
|
static containers during runtime.
|
||||||
This simplifies the instantiation of objects and allows the usage of some standard containers.
|
This simplifies the instantiation of objects and allows the usage of some
|
||||||
Dynamic Allocation after initialization is discouraged and different solutions are provided in the
|
standard containers.
|
||||||
FSFW to achieve that. The fsfw uses run-time type information but exceptions are not allowed.
|
Dynamic Allocation after initialization is discouraged and different solutions
|
||||||
|
are provided in the FSFW to achieve that. The fsfw uses run-time type
|
||||||
|
information but will not throw exceptions.
|
||||||
|
|
||||||
Failure Handling
|
Failure Handling
|
||||||
-----------------
|
-----------------
|
||||||
|
@ -3,6 +3,7 @@
|
|||||||
|
|
||||||
#include <utility>
|
#include <utility>
|
||||||
|
|
||||||
|
#include "fsfw/cfdp/pdu/PduConfig.h"
|
||||||
#include "FaultHandlerBase.h"
|
#include "FaultHandlerBase.h"
|
||||||
|
|
||||||
namespace cfdp {
|
namespace cfdp {
|
||||||
|
Loading…
Reference in New Issue
Block a user