private/hsb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen update

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@428 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
dvl
2018-01-15 11:40:43 +00:00
parent 15ab232e82
commit cfb55967c7
12 changed files with 111 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/Observable.h
View File

@@ -74,6 +74,7 @@ struct Observable
/**
* Initializes the Observable class.
* This is not needed if the Observable has been statically initialized by "struct Observable observable = OBSERVABLE_INITIALIZER".
* @memberof Observable
* @param self: address of the Observable struct.
* @retval none.
*/
@@ -81,6 +82,7 @@ void Observable_construct(struct Observable* self);
/**
* Terminates the Observable class. All Observers are removed.
* @memberof Observable
* @param self: address of the Observable struct.
* @retval none.
*/
@@ -88,6 +90,7 @@ void Observable_destruct(struct Observable* self);
/**
* Adds one Observer to the Observable.
* @memberof Observable
* @param self: address of the Observable struct.
* @param observer: Observer to be added.
* @retval ErrorStatus: returns an error in case the maximum number of Observers have been added.
@@ -97,6 +100,7 @@ ErrorStatus Observable_addObserver(struct Observable* self, const Observer obser
/**
* Adds one Observer to the Observable at the front of the list.
* This ensures that this Observer is notified before Observers added by Observable_addObserver.
* @memberof Observable
* @param self: address of the Observable struct.
* @param observer: Observer to be added.
* @retval ErrorStatus: returns an error in case the maximum number of Observers have been added.
@@ -106,6 +110,7 @@ ErrorStatus Observable_addObserverAtFront(struct Observable* self, const Observe
/**
* Notifies all Observers by calling the Observer callback function. The parameter void* data will be
* passed as parameter to the Observer.
* @memberof Observable
* @param self: address of the Observable struct.
* @param data: void pointer data to be passed as parameter to the Observer.
* @retval ErrorStatus: returns an error in case one or more of the Observers returned an error.
@@ -114,6 +119,7 @@ ErrorStatus Observable_notifyObservers(const struct Observable* self, const void
/**
* Deletes one specific Observer added before. If the Observer cannot be found, no action is taken.
* @memberof Observable
* @param self: address of the Observable struct.
* @param observer: Observer to be deleted.
*/
@@ -121,12 +127,14 @@ void Observable_deleteObserver(struct Observable* self, const Observer observer)
/**
* Deletes all Observers added.
* @memberof Observable
* @param self: address of the Observable struct.
*/
void Observable_deleteObservers(struct Observable* self);
/**
* Returns the number of Observers currently subscribed to an Observable.
* @memberof Observable
* @param self: address of the Observable struct.
*/
int Observable_nrOfObservers(struct Observable* self);