From: Razvan Becheriu Date: Wed, 6 May 2020 17:55:56 +0000 (+0300) Subject: [#1095] updated doxygen X-Git-Tag: Kea-1.7.8~136 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0f3dbf33677e298d884b3b018c4e3e94adc678ef;p=thirdparty%2Fkea.git [#1095] updated doxygen --- diff --git a/src/lib/util/state_model.cc b/src/lib/util/state_model.cc index a4fea31c34..afc6ee9981 100644 --- a/src/lib/util/state_model.cc +++ b/src/lib/util/state_model.cc @@ -25,7 +25,7 @@ State::~State() { void State::run() { - (handler_)(); + (handler_)(); } bool diff --git a/src/lib/util/state_model.h b/src/lib/util/state_model.h index 3df406dbaa..42f2d05e5c 100644 --- a/src/lib/util/state_model.h +++ b/src/lib/util/state_model.h @@ -249,6 +249,8 @@ public: /// "done". If the model fails (END_ST with a FAILED_EVT) it is considered /// "done" and "failed". There are several boolean status methods which may /// be used to check these conditions. +/// Once the model has been started, defining new events or new states is +/// illegal. It is possible to call startModel only once. /// /// To progress from one state to the another, state handlers invoke use /// the method, transition. This method accepts a state and an event as @@ -313,6 +315,7 @@ public: /// This method invokes initDictionaries method to initialize the event /// and state dictionaries and then starts the model execution setting /// the current state to the given start state, and the event to START_EVT. + /// This method can be called only once to start the state model. /// /// @param start_state is the state in which to begin execution. /// @@ -369,6 +372,7 @@ protected: /// /// This method invokes the define and verify methods for both events and /// states to initialize their respective dictionaries. + /// This method can be called only once to initialize the state model. /// /// @throw StateModelError or others indirectly, as this method calls /// dictionary define and verify methods.