Skip to content

Commit

Permalink
Revision of doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nils-hamel committed Feb 26, 2018
1 parent 77e63ab commit 0d15f14
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
4 changes: 2 additions & 2 deletions src/eratosthene-client/src/eratosthene-client-model.h
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
header - structures
*/

/*! \struct er_model_struct (revoked)
/*! \struct er_model_struct
* \brief Model structure
*
* This structure is responsible of maintaining the content of earth model
Expand All @@ -107,7 +107,7 @@
* procedure.
*
* The size field gives the amount of cell available in each stack while
* the \b mc_cell and \b md_virt are the base pointers of the actual and
* the \b md_cell and \b md_virt are the base pointers of the actual and
* target stacks.
*
* The update of the actual cells stack is made by the synchronisation
Expand Down
8 changes: 4 additions & 4 deletions src/eratosthene-client/src/eratosthene-client-times.h
Original file line number Diff line number Diff line change
Expand Up @@ -148,19 +148,19 @@
header - function prototypes
*/

/*! \brief constructor/destructor methods (revoked)
/*! \brief constructor/destructor methods
*
* This function creates and returns a times interface structure. Based on
* the screen resolution and font size, the function precomputes the
* the screen resolution and font size, the function pre-computes the
* interface elements horizontal and vertical positions.
*
* The function also allocate the memory of the time interface buffer and
* initialise its content. As the elements of the time interface are drawn
* through the alpha components of the buffer, the initialisation of the
* RGB components made by the function stands during the whole execution.
* RGB components made by this function stands during the whole execution.
*
* \param er_width Screen horizontal resolution, in pixels
* \param er_height Screen vertical position, in pixels
* \param er_height Screen vertical resolution, in pixels
*
* \return Returns the constructed time interface structure
*/
Expand Down
5 changes: 1 addition & 4 deletions src/eratosthene-client/src/eratosthene-client.h
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@

le_void_t er_client_loops_event( er_client_t * const er_client );

/*! \brief loop methods (revoked)
/*! \brief loop methods
*
* This function is called by the main loop function to trigger the earth
* model update according to the point of view.
Expand All @@ -350,9 +350,6 @@
* If the point of view has not changed, only the synchronisation takes
* place.
*
* If the execution mode is in movie mode, the synchronisation is called
* in a loop until the target and actual model are identical.
*
* \param er_client Client structure
*/

Expand Down

0 comments on commit 0d15f14

Please sign in to comment.