diff --git a/README b/README index 539faf6fcecfbe7d73417ab6a38ecedd5f6eddde..72b1e447616d3229b741b7f0eccd43c659fdedc4 100644 --- a/README +++ b/README @@ -9,6 +9,7 @@ sudo apt-get install libqt4-dev libqt4-opengl-dev libglut3-dev For Doxygen, it necessary to have epstopdf for the latex version. You can install it with the package texlive-extra-utils. +Also, install the dot program for graphics from the package graphviz. diff --git a/src/interface/render_area.hpp b/src/interface/render_area.hpp index a585ddba0171c7c89c0f99a087455cf95ee36086..39bd38d196ccedebbaf62ade692043156bf6f40c 100644 --- a/src/interface/render_area.hpp +++ b/src/interface/render_area.hpp @@ -17,13 +17,18 @@ class Render_area; #include "resource.hpp" - +/*! + * \brief Structure used to store event information. + */ struct Event_{ Element_pos time; Element_pos height; Element_pos container_height; }; +/*! + * \brief Structure used to store arrow information. + */ struct Arrow_{ Element_pos start_time; Element_pos end_time; diff --git a/src/interface/resource.hpp b/src/interface/resource.hpp index 3667b10c8ee6bab0084861a219a04bbe95f69466..c42bfc8d3facd7fa13d0d41c0aac41d6da17d8d6 100644 --- a/src/interface/resource.hpp +++ b/src/interface/resource.hpp @@ -20,10 +20,20 @@ #include <GL/glut.h> /* These paths corresponding to the path in the resource file ('vite.qrc' in the 'bin' folder) */ -#define UI_MAIN_WINDOW_NAME ":/window/main_window.ui"/* The main window ui file. */ -#define UI_INFO_WINDOW_NAME ":/window/info_window.ui"/* The info window ui file. */ +/*! + * \brief The main window ui file. + */ +#define UI_MAIN_WINDOW_NAME ":/window/main_window.ui" + +/*! + * \brief The info window ui file. + */ +#define UI_INFO_WINDOW_NAME ":/window/info_window.ui" +/*! + * \brief PI with a precision of 8. + */ #define PI 3.14159265 @@ -31,12 +41,23 @@ for pointer return value). Their body can be empty to enhance program speed. To pass multi arguments for m, use "<<" between each arguments. */ + +/*! + * \brief Checks if a function return -1 as a value. + * + * This macro is used with C functions to check them if an error occurs. Thus, it display the file, the line and some informations (with m variable) of the error than exit the program. + */ #define CKF(f, m) if((f)==-1) { \ cerr << "File " << __FILE__ <<" - line : " << __LINE__ <<endl; \ cerr << m <<endl; \ exit(EXIT_FAILURE); \ } +/*! + * \brief Checks if a function return NULL as a value. + * + * This macro is used with C functions to check them if an error occurs. Thus, it display the file, the line and some informations (with m variable) of the error than exit the program. + */ #define CKFP(f, m) if((f)==NULL) { \ cerr << "File " << __FILE__ <<" - line : " << __LINE__ <<endl; \ cerr << m <<endl; \