class comment formatting

This commit is contained in:
Robin Müller 2020-05-05 18:56:45 +02:00
parent 75da7a4c50
commit a6b3cee898

View File

@ -6,15 +6,21 @@
#include <list> #include <list>
/** /**
* \brief This class is the representation of a Polling Sequence Table in software. * @brief This class is the representation of a Polling Sequence Table in software.
* *
* \details The FixedSlotSequence object maintains the dynamic execution of device handler objects. * @details
* The main idea is to create a list of device handlers, to announce all handlers to the * The FixedSlotSequence object maintains the dynamic execution of
* polling sequence and to maintain a list of polling slot objects. This slot list represents the * device handler objects.
* Polling Sequence Table in software. Each polling slot contains information to indicate when and *
* which device handler shall be executed within a given polling period. * The main idea is to create a list of device handlers, to announce all
* The sequence is then executed by iterating through this slot list. * handlers to thepolling sequence and to maintain a list of
* Handlers are invoking by calling a certain function stored in the handler list. * polling slot objects. This slot list represents the Polling Sequence Table
* in software.
*
* Each polling slot contains information to indicate when and
* which device handler shall be executed within a given polling period.
* The sequence is then executed by iterating through this slot list.
* Handlers are invoking by calling a certain function stored in the handler list.
*/ */
class FixedSlotSequence { class FixedSlotSequence {
public: public: