Commit 337323cb authored by Johnny Jazeix's avatar Johnny Jazeix

Add doxygen documentation on trunk.

Merge trunk in the unified render branch which will be renamed to be 
another branch for new features.
parent 533cf08f
......@@ -31,7 +31,7 @@ PROJECT_NAME = ViTE
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 1.0
PROJECT_NUMBER = 1.1
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
......@@ -513,7 +513,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = src/interface/ src/message/ src/parser/ src/render/ src/trace/ src/trace/values/ src/trace/tree/ src/main.cpp src/main_resource.hpp src/statistics/ src/general/
INPUT = src/common/ src/core/ src/interface/ src/parser/ src/plugin/ src/render/ src/statistics/ src/trace/ src/trace/values/ src/trace/tree/ src/main.cpp
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
......
......@@ -93,16 +93,6 @@ double convert_to_double(const string arg){
}
#ifdef MEMORY_TRACE
/*
Function: clockGet
Timing routine.
Uses different timing routines depending on the machine architecture.
Returns:
Returns the time ellapsed since <clockStart>.
*/
double clockGet (void)
{
#if (defined X_ARCHalpha_compaq_osf1) || (defined X_ARCHi686_mac)
......
......@@ -61,6 +61,12 @@ double convert_to_double(const std::string args);
#define MIN(x,y) (((x)<(y))?(x):(y))
#define MAX(x,y) (((x)<(y))?(y):(x))
/*!
* \fn clockGet()
* \brief Timing routine.
* Uses different timing routines depending on the machine architecture.
* \return the time ellapsed since <clockStart>.
*/
double clockGet (void);
#endif // TOOLS_HPP
......@@ -78,7 +78,7 @@
*/
#define VITE_DATE "December 2009"
/*!
* \def VITE_DATE
* \def VITE_WEBSITE
* \brief the ViTE website (string)
*/
#define VITE_WEBSITE "http://vite.gforge.inria.fr"
......
......@@ -41,7 +41,7 @@
**
*/
/*!
*\file interface_console.hpp
*\file Core.hpp
*/
#ifndef CORE_HPP
......@@ -461,6 +461,9 @@ public:
void set_max_value_for_export(const double d);
/*!
*\brief Return the current trace.
*/
Trace *get_trace() const;
/*!
......
......@@ -41,7 +41,7 @@
**
*/
/*!
*\file interface.hpp
*\file Interface.hpp
*/
......
......@@ -41,7 +41,7 @@
**
*/
/*!
*\file interface_graphic.hpp
*\file Interface_graphic.hpp
*/
#ifndef INTERFACE_GRAPHIC_HPP
......@@ -81,14 +81,21 @@ class Interface_graphic : public QMainWindow, protected Ui::main_window, public
*/
void load_windows();
/*!
*\brief Drag and drop functions
*
*\brief Drag and drop function
*/
void dragEnterEvent(QDragEnterEvent *event);
/*!
*\brief Drag and drop function
*/
void dragMoveEvent(QDragMoveEvent *event);
/*!
*\brief Drag and drop function
*/
void dragLeaveEvent(QDragLeaveEvent *event);
/*!
*\brief Drag and drop function
*/
void dropEvent(QDropEvent *event);
/*!
......
......@@ -61,6 +61,9 @@ struct Field{
*/
std::string _type;
/*!
* \brief Constructor
*/
Field(const std::string &name, const std::string &type) : _name(name), _type(type){};
};
......
......@@ -83,7 +83,7 @@ public:
~File();
/*!
* \fn open()
* \fn open(std::string &filename)
* \brief Open the file
* \param filename the file name
*/
......@@ -96,7 +96,7 @@ public:
void close();
/*!
* \fn get_line()
* \fn get_line(Line &)
* \brief Get the next line.
* \return the next line
*/
......
......@@ -88,7 +88,7 @@ public:
/*!
* \fn fill_line(const std::string &string_line)
* \brief Split the string into tokens
* \param s string to be splitted
* \param string_line string to be splitted
*/
void fill_line(const std::string &string_line);
......@@ -130,7 +130,7 @@ public:
void set_line_number(const unsigned int n);
/*!
* \fn build_composite_token(std::string line, int index)
* \fn build_composite_token(const std::string &line, int index)
* \brief create a token within "" or ''
* \param line the line containing the token
* \param index from where we start to read the line
......
......@@ -55,12 +55,18 @@
class Parser{
protected:
/*!
* Set to true if the parsing is finished.
*/
bool _is_finished;
/*!
* Set to true if the parsing is canceled.
*/
bool _is_canceled;
public:
/*!
* \fn parse(std::string filename, Trace &trace) = 0
* \fn parse(const std::string &filename, Trace &trace, bool finish_trace_after_parse) = 0
* \param filename the name of the file to parse
* \param trace the structure of data to fill
* \param finish_trace_after_parse boolean set if we do not have to finish the trace after parsing
......@@ -89,7 +95,7 @@ public:
virtual void set_canceled() = 0;
/*!
* \fn set_file_to_parse(const std::string filename)
* \fn set_file_to_parse(const std::string &filename)
* \param filename : the name of the file to parse
* \brief set the name of the file to parse.
*/
......
......@@ -343,7 +343,7 @@ public:
static ProcessGroup get_processgroup_by_id(const int id);
/*!
* \fn get_processgroup_by_process(const int process_id)
* \fn get_processgroup_by_process(const unsigned int process_id)
* \brief Get the first processGroup which contains the process process_id
* \param process_id the id of the process we want the group
* \return The ProcessGroup associated to id
......
......@@ -80,13 +80,13 @@ public:
ParserDefinitionPaje();
/*!
* \fn definitions_number
* \fn definitions_number() const
* \return : the number of definitions in the map
*/
int definitions_number() const;
/*!
* \fn store_definition(Line &)
* \fn store_definition(const Line &l)
* \param l the line to store.
*/
void store_definition(const Line &l);
......@@ -99,7 +99,7 @@ public:
Definition &get_definition(unsigned int i);
/*!
* \fn get_hash_table_of_definitions
* \fn get_hash_table_of_definitions() const
* \return : the hash table of definitions
*/
const std::map<unsigned int,Definition> *get_hash_table_of_definitions() const;
......@@ -123,7 +123,7 @@ public:
*/
void add_field_to_definition(std::string& first_token, const Line& line);
/*! \fn print_definitions
/*! \fn print_definitions() const
* \brief Print all the definitions. Useful for debug.
*/
void print_definitions() const;
......
......@@ -105,7 +105,7 @@ public:
void set_handlers(Trace *t);
/*!
* \fn read_definitions(OTF_Reader *reader)
* \fn read_events(OTF_Reader *reader)
* \brief Begin the reading of the events
* \param reader The main otf file we want to read in.
*/
......
......@@ -71,7 +71,7 @@ public:
ParserOTF();
/*!
* \fn parse(std::string filename, Trace &trace)
* \fn parse(const std::string &filename, Trace &trace, bool finish_trace_after_parse)
* \param filename : the name of the file to parse
* \param trace : the structure of data to fill
* \param finish_trace_after_parse boolean set if we do not have to finish the trace after parsing
......@@ -79,7 +79,7 @@ public:
void parse(const std::string &filename, Trace &trace, bool finish_trace_after_parse = true);
/*!
* \fn set_file_to_parse(const std::string filename)
* \fn set_file_to_parse(const std::string &filename)
* \param filename : the name of the file to parse
* \brief set the name of the file to parse.
*/
......
......@@ -81,7 +81,7 @@ public:
~ParserPaje();
/*!
* \fn parse(std::string filename, Trace &trace)
* \fn parse(const std::string &filename, Trace &trace, bool finish_trace_after_parse)
* \param filename : the name of the file to parse
* \param trace : the structure of data to fill
* \param finish_trace_after_parse boolean set if we do not have to finish the trace after parsing
......@@ -89,7 +89,7 @@ public:
void parse(const std::string &filename, Trace &trace, bool finish_trace_after_parse = true);
/*!
* \fn set_file_to_parse(const std::string filename)
* \fn set_file_to_parse(const std::string &filename)
* \param filename : the name of the file to parse
* \brief set the name of the file to parse.
*/
......@@ -122,7 +122,7 @@ public:
void set_canceled();
/*!
* \fn get_definitions()
* \fn get_definitions() const
* \brief get the definitions from the parserdefinition
*/
const std::map<unsigned int, Definition> *get_definitions() const;
......
......@@ -72,14 +72,15 @@ public:
ParserVite();
/*!
* \fn parse(std::string filename, Trace &trace)
* \fn parse(const std::string &filename, Trace &trace, bool finish_trace_after_parse)
* \param filename : the name of the file to parse
* \param trace : the structure of data to fill
* \param finish_trace_after_parse : close the trace when parsing is finished if set to true
*/
void parse(const std::string &filename, Trace &trace, bool finish_trace_after_parse = true);
/*!
* \fn set_file_to_parse(const std::string filename)
* \fn set_file_to_parse(const std::string &filename)
* \param filename : the name of the file to parse
* \brief set the name of the file to parse.
*/
......
......@@ -41,7 +41,7 @@
**
*/
/*!
* \file command_window.hpp
* \file Command_window.hpp
*/
#ifndef _COMMAND_WINDOW_HPP
......
......@@ -41,7 +41,7 @@
**
*/
/*!
*\file render.hpp
*\file Render_template.hpp
*/
#ifndef RENDER_TEMPLATE_HPP
......
......@@ -182,7 +182,7 @@ public:
/*!
* \fn set_height_for_a_container()
* \fn set_height_for_one_container(Element_pos)
* \brief Useless for svg.
*/
void set_height_for_one_container(Element_pos /*h*/){};
......
......@@ -61,11 +61,11 @@ class Stats_window;
/*!
* \enum stattype
* \enum stattype_t
* \brief Enumeration for the kind of chart to print stats.
*
*/
typedef enum stattype {
typedef enum {
_HDIAGRAM_INDEX,
_DIAGRAM_INDEX,
_COUNTER_INDEX
......
......@@ -131,7 +131,7 @@ public:
void add_child(Container *child);
/*!
* \fn set_state(Date time, StateType *type, EntityValue *value, map<std::string, Value *> &opt)
* \fn set_state(Date time, StateType *type, EntityValue *value, std::map<std::string, Value *> &opt)
* \brief Set the current state of the container
* \param time Date of the event
* \param type Type of the state
......@@ -141,7 +141,7 @@ public:
void set_state(Date time, StateType *type, EntityValue *value, std::map<std::string, Value *> &opt);
/*!
* \fn push_state(Date time, StateType *type, EntityValue *value, map<std::string, Value *> &opt)
* \fn push_state(Date time, StateType *type, EntityValue *value, std::map<std::string, Value *> &opt)
* \brief Set the current state of the container and save the previous state
* \param time Date of the event
* \param type Type of the state
......@@ -158,7 +158,7 @@ public:
void pop_state(Date time);
/*!
* \fn new_event(Date time, EventType *type, EntityValue *value, map<std::string, Value *> &opt)
* \fn new_event(Date time, EventType *type, EntityValue *value, std::map<std::string, Value *> &opt)
* \brief Add a new event
* \param time Date of the event
* \param type Type of the event
......@@ -168,7 +168,7 @@ public:
void new_event(Date time, EventType *type, EntityValue *value, std::map<std::string, Value *> &opt);
/*!
* \fn start_link(Date time, LinkType *type, Container *source, EntityValue *value, String key, map<std::string, Value *> &opt)
* \fn start_link(Date time, LinkType *type, Container *source, EntityValue *value, String key, std::map<std::string, Value *> &opt)
* \brief Start a new link identified by key
* \param time Date of the start of the link
* \param type Type of the link
......@@ -180,7 +180,7 @@ public:
void start_link(Date time, LinkType *type, Container *source, EntityValue *value, String key, std::map<std::string, Value *> &opt);
/*!
* \fn end_link(Date time, Container *destination, String key, map<std::string, Value *> &opt)
* \fn end_link(Date time, Container *destination, String key, std::map<std::string, Value *> &opt)
* \brief End a link identified by key
* \param time Date of the end of the link
* \param destination Container to where the link is sent
......
......@@ -103,7 +103,7 @@ public:
}
/*!
* \fn browse_tree(const Interval &I, Node<E> *node)
* \fn browse_tree(const Interval &I, Node<E> *node, bool &b)
* \brief Function called to draw on ViTE a node
* \param I : The interval we have to draw node
* \param node : The node we want to draw
......@@ -125,9 +125,12 @@ public:
}
/*!
* \fn draw_event(double time)
* \fn draw_event(double time, double r, double g, double b)
* \brief Draw an event
* \param time Time of the event
* \param r the value of the red component
* \param g the value of the green component
* \param b the value of the blue component
*/
inline void draw_event(double time, double r, double g, double b) {
Element_pos y = _position*(_container_height+_container_v_space) + _container_v_space/2;
......@@ -150,7 +153,7 @@ public:
template<class D, class E>
struct DrawNode {
/*!
* \fn draw_node(DrawTree<D, E> *draw, Node<E> *node)
* \fn draw_node(DrawTree<D, E> *draw, Node<E> *node, bool & b, const Interval * i)
* \brief To draw a node of type E with a painting object of type D
*/
static void draw_node(DrawTree<D, E> *draw, Node<E> *node, bool & b, const Interval * i) { }
......@@ -163,10 +166,10 @@ struct DrawNode {
template<class D>
struct DrawNode<D, Event> {
/*!
* \fn draw_node(DrawTree<D, Event> *draw, Node<Event> *node)
* \fn draw_node(DrawTree<D, Event> *draw, Node<Event> *node, bool &b, const Interval * i)
* \brief To draw a node of type Event with a painting object of type D
*/
static void draw_node(DrawTree<D, Event> *draw, Node<Event> *node,bool &b, const Interval * i) {
static void draw_node(DrawTree<D, Event> *draw, Node<Event> *node, bool &b, const Interval * i) {
//Just to avoid warning at the compilation, these 2 parameters are only useful in draw_node<stateChange>
b=true;
i++;
......@@ -266,12 +269,12 @@ struct DrawNode<D, StateChange> {
template<class D, class E>
/*!
*\fn DrawTree<D, E>::browse_tree(const Interval &I, Node<E> * node)
*\fn DrawTree<D, E>::browse_tree(const Interval &I, Node<E> * node, bool &b)
*\brief Function that browses a tree to display
*\param I The interval we have to display node
*\param node The node in the tree we want to display
*/
void DrawTree<D, E>::browse_tree(const Interval &I, Node<E> *node, bool & b) {
void DrawTree<D, E>::browse_tree(const Interval &I, Node<E> *node, bool &b) {
if(!node)
return;
......
......@@ -60,7 +60,7 @@ private:
protected:
/*!
* \fn EntityType(Name name, ContainerType *container_type, map<std::string, Value *> opt)
* \fn EntityType(Name name, ContainerType *container_type, std::map<std::string, Value *> opt)
* \brief Default constructor
* \param name Name of the entity type
* \param container_type The type of container
......
......@@ -59,7 +59,7 @@ private:
public:
/*!
* \fn EntityValue(const Name &name, EntityType *type, map<std::string, Value *> opt);
* \fn EntityValue(const Name &name, EntityType *type, std::map<std::string, Value *> opt);
* \brief EntityValue Constructor
* \param name Name of the value
* \param type EntityType to which the value apply
......
......@@ -61,7 +61,7 @@ private:
public:
/*!
* \fn Event(Date time, EventType *type, Container *container, EntityValue *value, map<std::string, Value *> opt)
* \fn Event(Date time, EventType *type, Container *container, EntityValue *value, std::map<std::string, Value *> opt)
* \brief Event Constructor
* \param time Date of the event
* \param type Type of the event
......
......@@ -55,7 +55,7 @@ private:
public :
/*!
* \fn EventType(Name name, ContainerType *container_type, map<std::string, Value *> opt)
* \fn EventType(Name name, ContainerType *container_type, std::map<std::string, Value *> opt)
* \brief EventTytpe Constructor
* \param name Name of the type
* \param container_type Type of the container for event of this type
......
......@@ -57,7 +57,7 @@ private:
public :
/*!
* \fn LinkType(Name name, ContainerType *container_type, ContainerType *source_type, ContainerType *destination_type, map<std::string, Value *> opt)
* \fn LinkType(Name name, ContainerType *container_type, ContainerType *source_type, ContainerType *destination_type, std::map<std::string, Value *> opt)
* \brief Constructor
* \param name Name of type
* \param container_type Type of ancestor container
......
......@@ -55,7 +55,7 @@ private:
public:
/*!
* \fn StateType(Name name, ContainerType *container_type, map<std::string, Value *> opt)
* \fn StateType(Name name, ContainerType *container_type, std::map<std::string, Value *> opt)
* \brief Constructor
* \param name The name of the state type
* \param container_type The type of the container that contains the states
......
......@@ -307,7 +307,7 @@ public :
const std::list <Container *> *get_root_containers() const;
/*!
* \fn get_all_containers() const
* \fn get_all_containers(std::list <Container *> &list_to_fill) const
* \brief Get the list of all the containers
* \param list_to_fill the list to fill
*/
......@@ -388,7 +388,7 @@ public :
double get_filter();
/*!
* \fn get_all_variables()
* \fn get_all_variables(std::map<std::string, Variable *> &map_to_fill)
* \brief returns a map of all the variables
* A Variable do not have a name so the key is:
* Container name + " " + VariableType name
......
......@@ -57,6 +57,9 @@
*/
class Value {
protected:
/*!
* boolean at true if the value set is correct.
*/
bool _is_correct;
public:
......
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