Commit d0e529e8 authored by Olivier Lagrasse's avatar Olivier Lagrasse

ajout commentaires dans interface/resource.hpp et

render_area.hpp
ajout dans README l'utilisation de graphviz pour Doxygen
parent 533656fe
...@@ -9,6 +9,7 @@ sudo apt-get install libqt4-dev libqt4-opengl-dev libglut3-dev ...@@ -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. 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.
......
...@@ -17,13 +17,18 @@ class Render_area; ...@@ -17,13 +17,18 @@ class Render_area;
#include "resource.hpp" #include "resource.hpp"
/*!
* \brief Structure used to store event information.
*/
struct Event_{ struct Event_{
Element_pos time; Element_pos time;
Element_pos height; Element_pos height;
Element_pos container_height; Element_pos container_height;
}; };
/*!
* \brief Structure used to store arrow information.
*/
struct Arrow_{ struct Arrow_{
Element_pos start_time; Element_pos start_time;
Element_pos end_time; Element_pos end_time;
......
...@@ -20,10 +20,20 @@ ...@@ -20,10 +20,20 @@
#include <GL/glut.h> #include <GL/glut.h>
/* These paths corresponding to the path in the resource file ('vite.qrc' in the 'bin' folder) */ /* 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 #define PI 3.14159265
...@@ -31,12 +41,23 @@ ...@@ -31,12 +41,23 @@
for pointer return value). Their body can be empty to enhance program speed. for pointer return value). Their body can be empty to enhance program speed.
To pass multi arguments for m, use "<<" between each arguments. 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) { \ #define CKF(f, m) if((f)==-1) { \
cerr << "File " << __FILE__ <<" - line : " << __LINE__ <<endl; \ cerr << "File " << __FILE__ <<" - line : " << __LINE__ <<endl; \
cerr << m <<endl; \ cerr << m <<endl; \
exit(EXIT_FAILURE); \ 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) { \ #define CKFP(f, m) if((f)==NULL) { \
cerr << "File " << __FILE__ <<" - line : " << __LINE__ <<endl; \ cerr << "File " << __FILE__ <<" - line : " << __LINE__ <<endl; \
cerr << m <<endl; \ cerr << m <<endl; \
......
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