diff --git a/src/interface/interface_console.hpp b/src/interface/interface_console.hpp index 9f18f932d407e766d04173e8e5b0378389ae904e..2fa2587b11cee1347cb2958c1d9db74fe1d28264 100644 --- a/src/interface/interface_console.hpp +++ b/src/interface/interface_console.hpp @@ -174,8 +174,8 @@ protected: /*! * \brief The default constructor of the class. - * \arg argc : the number of parameters given when the program was called. - * argv : a set of strings which contains each parameter. + * \param argc : the number of parameters given when the program was called. + * \param argv : a set of strings which contains each parameter. */ Interface_console(int argc, char** argv); diff --git a/src/interface/render_area.hpp b/src/interface/render_area.hpp index 24dd8e2e4554e8ec9ca552be73c4a966fd1bba13..a7b1bc81631da0a3167e2fd4c0591c33d59598d3 100644 --- a/src/interface/render_area.hpp +++ b/src/interface/render_area.hpp @@ -21,8 +21,17 @@ class Render_area; * \brief Structure used to store event information. */ struct Event_{ + /*! + * \brief time of an event + */ Element_pos time; + /*! + * \brief height of an event + */ Element_pos height; + /*! + * \brief height of the container + */ Element_pos container_height; }; @@ -30,9 +39,21 @@ struct Event_{ * \brief Structure used to store arrow information. */ struct Arrow_{ + /*! + * \brief time when the arrow starts + */ Element_pos start_time; + /*! + * \brief time when the arrow ends + */ Element_pos end_time; + /*! + * \brief ? + */ Element_pos start_height; + /*! + * \brief ? + */ Element_pos end_height; }; diff --git a/src/interface/render_svg.hpp b/src/interface/render_svg.hpp index c9f21616ad8a83c30878b375b5cc01fe059682b9..f29370f8a8dd6ec38fac28276a865410fab8db35 100644 --- a/src/interface/render_svg.hpp +++ b/src/interface/render_svg.hpp @@ -26,6 +26,9 @@ #define max(a,b) (a>b?a:b); #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{ @@ -80,6 +83,7 @@ public: * \param start the beginning time of the state. * \param end the ending time of the state. * \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) ; @@ -101,6 +105,10 @@ public: void end_draw(); + /*! + * \brief Set the precision of SVG display. + * \param epsilon Precision + */ void set_accuracy(double epsilon); }; diff --git a/src/main_resource.hpp b/src/main_resource.hpp index caf85120ed03f43e4b62b103e4104a7fe596e784..7c9e8149c46e69f6c2d1e025641fe6eacc1fcf9b 100644 --- a/src/main_resource.hpp +++ b/src/main_resource.hpp @@ -13,8 +13,17 @@ #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 ; +/*! + * \brief Unity for variables of position of a element in the display such as height, abscissa... + */ typedef double Element_pos; +/*! + * \brief unity for colors + */ typedef double Element_col; diff --git a/src/trace/resource.hpp b/src/trace/resource.hpp index ea572b573eb0ed2187b3cb2ddadabf13c1e347a0..55c3ba046f9e49ffb5a9f24a6808c4d31ef5c68d 100644 --- a/src/trace/resource.hpp +++ b/src/trace/resource.hpp @@ -1,5 +1,5 @@ /*! - *\file resource.hpp + *\file trace/resource.hpp *\brief This file gives some common header files for the trace classes. */