Commit a373d1fe authored by Arthur Redondy's avatar Arthur Redondy

corrections de warning de doxygen

parent 166dd2a3
...@@ -174,8 +174,8 @@ protected: ...@@ -174,8 +174,8 @@ protected:
/*! /*!
* \brief The default constructor of the class. * \brief The default constructor of the class.
* \arg argc : the number of parameters given when the program was called. * \param argc : the number of parameters given when the program was called.
* argv : a set of strings which contains each parameter. * \param argv : a set of strings which contains each parameter.
*/ */
Interface_console(int argc, char** argv); Interface_console(int argc, char** argv);
......
...@@ -21,8 +21,17 @@ class Render_area; ...@@ -21,8 +21,17 @@ class Render_area;
* \brief Structure used to store event information. * \brief Structure used to store event information.
*/ */
struct Event_{ struct Event_{
/*!
* \brief time of an event
*/
Element_pos time; Element_pos time;
/*!
* \brief height of an event
*/
Element_pos height; Element_pos height;
/*!
* \brief height of the container
*/
Element_pos container_height; Element_pos container_height;
}; };
...@@ -30,9 +39,21 @@ struct Event_{ ...@@ -30,9 +39,21 @@ struct Event_{
* \brief Structure used to store arrow information. * \brief Structure used to store arrow information.
*/ */
struct Arrow_{ struct Arrow_{
/*!
* \brief time when the arrow starts
*/
Element_pos start_time; Element_pos start_time;
/*!
* \brief time when the arrow ends
*/
Element_pos end_time; Element_pos end_time;
/*!
* \brief ?
*/
Element_pos start_height; Element_pos start_height;
/*!
* \brief ?
*/
Element_pos end_height; Element_pos end_height;
}; };
......
...@@ -26,6 +26,9 @@ ...@@ -26,6 +26,9 @@
#define max(a,b) (a>b?a:b); #define max(a,b) (a>b?a:b);
#define min(a,b) (a>b?b:a); #define min(a,b) (a>b?b:a);
/*!
* \brief This class provides a SVG display ,it inherited from the Render interface.
*/
class Svg : public Render{ class Svg : public Render{
...@@ -80,6 +83,7 @@ public: ...@@ -80,6 +83,7 @@ public:
* \param start the beginning time of the state. * \param start the beginning time of the state.
* \param end the ending time of the state. * \param end the ending time of the state.
* \param level refer to the container which state belongs to. * \param level refer to the container which state belongs to.
* \param height Unused parameter yet.
*/ */
void draw_state(const Element_pos start , const Element_pos end, const Element_pos level, const Element_pos height, const Element_col r, const Element_col g, const Element_col b) ; void draw_state(const Element_pos start , const Element_pos end, const Element_pos level, const Element_pos height, const Element_col r, const Element_col g, const Element_col b) ;
...@@ -101,6 +105,10 @@ public: ...@@ -101,6 +105,10 @@ public:
void end_draw(); void end_draw();
/*!
* \brief Set the precision of SVG display.
* \param epsilon Precision
*/
void set_accuracy(double epsilon); void set_accuracy(double epsilon);
}; };
......
...@@ -13,8 +13,17 @@ ...@@ -13,8 +13,17 @@
#include <cstdlib> /* for macros EXIT_SUCCESS and EXIT_FAILURE */ #include <cstdlib> /* for macros EXIT_SUCCESS and EXIT_FAILURE */
/*!
* \brief unity for count elements such as number of states or events... NOT USED YET
*/
typedef long Element_count ; typedef long Element_count ;
/*!
* \brief Unity for variables of position of a element in the display such as height, abscissa...
*/
typedef double Element_pos; typedef double Element_pos;
/*!
* \brief unity for colors
*/
typedef double Element_col; typedef double Element_col;
......
/*! /*!
*\file resource.hpp *\file trace/resource.hpp
*\brief This file gives some common header files for the trace classes. *\brief This file gives some common header files for the trace classes.
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment