[FIX] API documentation

Author: sarthou

docs/ClientBase.html

@@ -124,26 +124,26 @@ <h2 id="details">Detailed Description</h2>
         <div class="func">
           <h2>Public Functions Documentation</h2>
 
-          <h3 class="fn" id="ClientBase"><a name="ClientBase"></a>ClientBase::<span class="name">ClientBase</span>(<span class="type">ros::NodeHandle</span>*<i> n</i>, const <span class="type">std::string</span>&amp; <i>name</i>)</h3>
+          <h3 class="fn" id="ClientBase"><a name="ClientBase"></a>mementar::ClientBase::<span class="name">ClientBase</span>(<span class="type">ros::NodeHandle</span>*<i> n</i>, const <span class="type">std::string</span>&amp; <i>name</i>)</h3>
           <p>Constructs a ROS client linked to the service <i>name</i> with a pointer to a NodeHandle <i>n</i>.</p>
 
-          <h3 class="fn" id="nb"><a name="nb"></a><span class="type">size_t</span> ClientBase::<span class="name">nb</span>()</h3>
+          <h3 class="fn" id="nb"><a name="nb"></a><span class="type">size_t</span> mementar::ClientBase::<span class="name">nb</span>()</h3>
           <p>Gives the total number of service calls from all ClientBase instances since the last reset.</p>
 
-          <h3 class="fn" id="resetNb"><a name="resetNb"></a><span class="type">void</span> ClientBase::<span class="name">resetNb</span>()</h3>
+          <h3 class="fn" id="resetNb"><a name="resetNb"></a><span class="type">void</span> mementar::ClientBase::<span class="name">resetNb</span>()</h3>
           <p>Reset Call Counter for all instances of ClientBase.</p>
 
           <h2>Protected Function Documentation</h2>
 
-          <h3 class="fn" id="call"><a name="call"></a>inline <span class="type">std::vector&lt;std::string&gt;</span> ClientBase::<span class="name">call</span>(<span class="type">mementar::MementarService</span>&amp; <i>srv</i>)</h3>
+          <h3 class="fn" id="call"><a name="call"></a>inline <span class="type">std::vector&lt;std::string&gt;</span> mementar::ClientBase::<span class="name">call</span>(<span class="type">mementar::MementarService</span>&amp; <i>srv</i>)</h3>
           <p>Call the service setup in the constructor of ClientBase with the request <i>srv</i></p>
           <p>If the service call fails, the first element of the returned vector is &quot;ERR:SERVICE_FAIL&quot;.</p>
 
-          <h3 class="fn" id="callStr"><a name="callStr"></a>inline <span class="type">std::string</span> ClientBase::<span class="name">callStr</span>(<span class="type">mementar::MementarService</span>&amp; <i>srv</i>)</h3>
+          <h3 class="fn" id="callStr"><a name="callStr"></a>inline <span class="type">std::string</span> mementar::ClientBase::<span class="name">callStr</span>(<span class="type">mementar::MementarService</span>&amp; <i>srv</i>)</h3>
           <p>Call the service setup in the constructor of ClientBase with the request <i>srv</i></p>
           <p>If the service call fails, the returned value is &quot;ERR:SERVICE_FAIL&quot;.</p>
 
-          <h3 class="fn" id="callNR"><a name="callNR"></a>inline <span class="type">bool</span> ClientBase::<span class="name">callNR</span>(<span class="type">mementar::MementarService</span>&amp; <i>srv</i>)</h3>
+          <h3 class="fn" id="callNR"><a name="callNR"></a>inline <span class="type">bool</span> mementar::ClientBase::<span class="name">callNR</span>(<span class="type">mementar::MementarService</span>&amp; <i>srv</i>)</h3>
           <p>Call the service setup in the constructor of ClientBase with the request <i>srv</i></p>
           <p>Return false if the service call fails.</p>
 

docs/Event.html

@@ -117,36 +117,36 @@ <h2 id="details">Detailed Description</h2>
         <div class="func">
           <h2>Public Functions Documentation</h2>
 
-          <h3 class="fn" id="Event"><a name="Event"></a>Event::<span class="name">Event</span>(const <span class="type">std::string</span>&amp; <i>event</i>)</h3>
+          <h3 class="fn" id="Event"><a name="Event"></a>mementar::Event::<span class="name">Event</span>(const <span class="type">std::string</span>&amp; <i>event</i>)</h3>
           <p>Constructs a new event from the formatted parameter <i>event</i>.</p>
           <p>In its formatted form, an event is written as follows: subject|predicat|object</p>
 
-          <h3 class="fn" id="Event2"><a name="Event2"></a>Event::<span class="name">Event</span>(const <span class="type">std::string</span>&amp; <i>subject</i>, const <span class="type">std::string</span>&amp; <i>predicat</i>, const <span class="type">std::string</span>&amp; <i>object</i>)</h3>
+          <h3 class="fn" id="Event2"><a name="Event2"></a>mementar::Event::<span class="name">Event</span>(const <span class="type">std::string</span>&amp; <i>subject</i>, const <span class="type">std::string</span>&amp; <i>predicat</i>, const <span class="type">std::string</span>&amp; <i>object</i>)</h3>
           <p>Constructs a new event from the triplet defined by the parameters <i>subject</i>, <i>predicat</i> and <i>object</i>.</p>
 
-          <h3 class="fn" id="subject_get"><a name="subject_get"></a><span class="type">std::string</span> EventsPublisher::<span class="name">subject</span>()</h3>
+          <h3 class="fn" id="subject_get"><a name="subject_get"></a><span class="type">std::string</span> mementar::Event::<span class="name">subject</span>()</h3>
           <p>Return the subject of the event.</p>
 
-          <h3 class="fn" id="predicat_get"><a name="predicat_get"></a><span class="type">std::string</span> EventsPublisher::<span class="name">predicat</span>()</h3>
+          <h3 class="fn" id="predicat_get"><a name="predicat_get"></a><span class="type">std::string</span> mementar::Event::<span class="name">predicat</span>()</h3>
           <p>Return the predicat of the event.</p>
 
-          <h3 class="fn" id="object_get"><a name="object_get"></a><span class="type">std::string</span> EventsPublisher::<span class="name">object</span>()</h3>
+          <h3 class="fn" id="object_get"><a name="object_get"></a><span class="type">std::string</span> mementar::Event::<span class="name">object</span>()</h3>
           <p>Return the object of the event.</p>
 
-          <h3 class="fn" id="operator_get"><a name="operator_get"></a><span class="type">std::string</span> EventsPublisher::<span class="name">operator()</span>()</h3>
+          <h3 class="fn" id="operator_get"><a name="operator_get"></a><span class="type">std::string</span> mementar::Event::<span class="name">operator()</span>()</h3>
           <p>Return the event in its formatted form.</p>
           <p>In its formatted form, an event is written as follows: subject|predicat|object</p>
 
-          <h3 class="fn" id="subject_set"><a name="subject_set"></a><span class="type">void</span> EventsPublisher::<span class="name">subject</span>(const <span class="type">std::string</span>&amp; <i>subject</i>)</h3>
+          <h3 class="fn" id="subject_set"><a name="subject_set"></a><span class="type">void</span> mementar::Event::<span class="name">subject</span>(const <span class="type">std::string</span>&amp; <i>subject</i>)</h3>
           <p>Set the subject of the event.</p>
 
-          <h3 class="fn" id="predicat_set"><a name="predicat_set"></a><span class="type">void</span> EventsPublisher::<span class="name">predicat</span>(const <span class="type">std::string</span>&amp; <i>predicat</i>)</h3>
+          <h3 class="fn" id="predicat_set"><a name="predicat_set"></a><span class="type">void</span> mementar::Event::<span class="name">predicat</span>(const <span class="type">std::string</span>&amp; <i>predicat</i>)</h3>
           <p>Set the predicat of the event.</p>
 
-          <h3 class="fn" id="object_set"><a name="object_set"></a><span class="type">void</span> EventsPublisher::<span class="name">object</span>(const <span class="type">std::string</span>&amp; <i>object</i>)</h3>
+          <h3 class="fn" id="object_set"><a name="object_set"></a><span class="type">void</span> mementar::Event::<span class="name">object</span>(const <span class="type">std::string</span>&amp; <i>object</i>)</h3>
           <p>Set the object of the event.</p>
 
-          <h3 class="fn" id="operator_set"><a name="operator_set"></a><span class="type">void</span> EventsPublisher::<span class="name">operator()</span>(const <span class="type">std::string</span>&amp; <i>event</i>)</h3>
+          <h3 class="fn" id="operator_set"><a name="operator_set"></a><span class="type">void</span> mementar::Event::<span class="name">operator()</span>(const <span class="type">std::string</span>&amp; <i>event</i>)</h3>
           <p>Set the event using its formatted form.</p>
           <p>In its formatted form, an event is written as follows: subject|predicat|object</p>
 

docs/EventsPublisher.html

@@ -110,11 +110,11 @@ <h2 id="details">Detailed Description</h2>
         <div class="func">
           <h2>Public Functions Documentation</h2>
 
-          <h3 class="fn" id="EventsPublisher"><a name="EventsPublisher"></a>EventsPublisher::<span class="name">EventsPublisher</span>(<span class="type">ros::NodeHandle</span>*<i> n</i>, const <span class="type">std::string</span>&amp; <i>name</i> = "")</h3>
+          <h3 class="fn" id="EventsPublisher"><a name="EventsPublisher"></a>mementar::EventsPublisher::<span class="name">EventsPublisher</span>(<span class="type">ros::NodeHandle</span>*<i> n</i>, const <span class="type">std::string</span>&amp; <i>name</i> = "")</h3>
           <p>Constructs an EventsPublisher with a pointer to a NodeHandle <i>n</i>.</p>
           <p>Can be used in a multi-process mode by specifying the name of the mementar instance <i>name</i>. For classic use, <i>name</i> should be defined as &quot;&quot;.</p>
 
-          <h3 class="fn" id="insert2"><a name="insert2"></a><span class="type">void</span> EventsPublisher::<span class="name">insert</span>(const <span class="type"><a href="Event.html">Event</a></span>&amp; <i>data</i>, <span class="type">time_t</span>&amp; <i>stamp</i> = 0)</h3>
+          <h3 class="fn" id="insert2"><a name="insert2"></a><span class="type">void</span> mementar::EventsPublisher::<span class="name">insert</span>(const <span class="type"><a href="Event.html">Event</a></span>&amp; <i>data</i>, <span class="type">time_t</span>&amp; <i>stamp</i> = 0)</h3>
           <p>Inserts the event defined in the <i>event</i> object.</p>
           <p>The event can be stamped using the <i>stamp</i> parameter. If the stamp parameter is not set (set to default 0), it will be set at the current time.</p>
 

docs/EventsSubscriber.html

@@ -113,29 +113,29 @@ <h2 id="details">Detailed Description</h2>
         <div class="func">
           <h2>Public Functions Documentation</h2>
 
-          <h3 class="fn" id="EventsSubscriber"><a name="EventsSubscriber"></a>EventsSubscriber::<span class="name">EventsSubscriber</span>(const <span class="type">std::function&lt;void(<a href="Event.html">Event</a>&amp;)&gt;</span> <i>callback</i>, const <span class="type">std::string</span>&amp; <i>name</i> = "", <span class="type">bool</span> <i>spin_thread</i> = true)</h3>
+          <h3 class="fn" id="EventsSubscriber"><a name="EventsSubscriber"></a>mementar::EventsSubscriber::<span class="name">EventsSubscriber</span>(const <span class="type">std::function&lt;void(<a href="Event.html">Event</a>&amp;)&gt;</span> <i>callback</i>, const <span class="type">std::string</span>&amp; <i>name</i> = "", <span class="type">bool</span> <i>spin_thread</i> = true)</h3>
           <p>Constructs an EventsSubscriber with a callback function <i>callback</i>.</p>
           <p>The EventsSubscriber constructor also takes a boolean option to automatically spin a thread. If you prefer not to use threads (and you want the EventsSubscriber to do the 'thread magic' behind the scenes), this is a good option for you.</p>
           <p>Can be used in a multi-process mode by specifying the name of the mementar instance <i>name</i>. For classic use, <i>name</i> should be defined as &quot;&quot;.</p>
 
-          <h3 class="fn" id="EventsSubscriber2"><a name="EventsSubscriber2"></a>EventsSubscriber::<span class="name">EventsSubscriber</span>(const <span class="type">std::function&lt;void(<a href="Event.html">Event</a>&amp;)&gt;</span> <i>callback</i>, <span class="type">bool</span> <i>spin_thread</i>)</h3>
+          <h3 class="fn" id="EventsSubscriber2"><a name="EventsSubscriber2"></a>mementar::EventsSubscriber::<span class="name">EventsSubscriber</span>(const <span class="type">std::function&lt;void(<a href="Event.html">Event</a>&amp;)&gt;</span> <i>callback</i>, <span class="type">bool</span> <i>spin_thread</i>)</h3>
           <p>Constructs an EventsSubscriber with a callback function <i>callback</i>.</p>
           <p>The EventsSubscriber constructor also takes a boolean option to automatically spin a thread. If you prefer not to use threads (and you want the EventsSubscriber to do the 'thread magic' behind the scenes), this is a good option for you.</p>
 
-          <h3 class="fn" id="EventsSubscriber_dest"><a name="EventsSubscriber_dest"></a>EventsSubscriber::<span class="name">~EventsSubscriber</span>()</h3>
+          <h3 class="fn" id="EventsSubscriber_dest"><a name="EventsSubscriber_dest"></a>mementar::EventsSubscriber::<span class="name">~EventsSubscriber</span>()</h3>
           <p>The EventsSubscriber destructor cancel all the subscriptions previous done.</p>
 
-          <h3 class="fn" id="subscribe"><a name="subscribe"></a><span class="type">bool</span> EventsPublisher::<span class="name">subscribe</span>(const <span class="type"><a href="Event.html">Event</a></span>&amp; <i>pattern</i>, <span class="type">size_t</span>&amp; <i>count</i> = -1)</h3>
+          <h3 class="fn" id="subscribe"><a name="subscribe"></a><span class="type">bool</span> mementar::EventsSubscriber::<span class="name">subscribe</span>(const <span class="type"><a href="Event.html">Event</a></span>&amp; <i>pattern</i>, <span class="type">size_t</span>&amp; <i>count</i> = -1)</h3>
           <p>Subscribe to the event pattern <i>pattern</i> defined as an Event object.</p>
           <p>A pattern can be constructed as a classic event, but each component of the triplet can also be set to the value &quot;?&quot; to represent anything.</p>
           <p>The <i>count</i> parameter defines the number of events corresponding to the model you want to know. By using the default value -1, the number of events is unlimited.</p>
           <p>Returns false if the subscription failed.<p>
 
-          <h3 class="fn" id="cancel"><a name="cancel"></a><span class="type">bool</span> EventsPublisher::<span class="name">cancel</span>()</h3>
+          <h3 class="fn" id="cancel"><a name="cancel"></a><span class="type">bool</span> mementar::EventsSubscriber::<span class="name">cancel</span>()</h3>
           <p>Cancel all subscriptions.</p>
           <p>Returns false if at least one subscription fails.<p>
 
-          <h3 class="fn" id="end"><a name="end"></a><span class="type">bool</span> EventsPublisher::<span class="name">end</span>()</h3>
+          <h3 class="fn" id="end"><a name="end"></a><span class="type">bool</span> mementar::EventsSubscriber::<span class="name">end</span>()</h3>
           <p>Returns true if no more events are expected.</p>
           <p>If at least one subscription has been made with an account set to -1, the end function will always return false until the next cancellation.</p>
 

docs/ManagerClient.html

@@ -120,18 +120,18 @@ <h2 id="details">Detailed Description</h2>
         <div class="func">
           <h2>Public Functions Documentation</h2>
 
-          <h3 class="fn" id="ManagerClient"><a name="ManagerClient"></a>ManagerClient::<span class="name">ManagerClient</span>(<span class="type">ros::NodeHandle</span>*<i> n</i>)</h3>
+          <h3 class="fn" id="ManagerClient"><a name="ManagerClient"></a>mementar::ManagerClient::<span class="name">ManagerClient</span>(<span class="type">ros::NodeHandle</span>*<i> n</i>)</h3>
           <p>Constructs an manager client with a pointer to a NodeHandle <i>n</i>.</p>
           <p>Can only be used in a multi-process mode.</p>
 
-          <h3 class="fn" id="list"><a name="list"></a><span class="type">std::vector&lt;std::string&gt;</span> ManagerClient::<span class="name">list</span>()</h3>
+          <h3 class="fn" id="list"><a name="list"></a><span class="type">std::vector&lt;std::string&gt;</span> mementar::ManagerClient::<span class="name">list</span>()</h3>
           <p>Returns the name of the intanced mementar process.</p>
 
-          <h3 class="fn" id="add"><a name="add"></a><span class="type">bool</span> ManagerClient::<span class="name">add</span>(const <span class="type">std::string</span>&amp; <i>name</i>)</h3>
+          <h3 class="fn" id="add"><a name="add"></a><span class="type">bool</span> mementar::ManagerClient::<span class="name">add</span>(const <span class="type">std::string</span>&amp; <i>name</i>)</h3>
           <p>Create an mementar instance named <i>name</i>.</p>
           <p>Returns false if the service call fails.</p>
 
-          <h3 class="fn" id="del"><a name="del"></a><span class="type">bool</span> ManagerClient::<span class="name">del</span>(const <span class="type">std::string</span>&amp; <i>name</i>)</h3>
+          <h3 class="fn" id="del"><a name="del"></a><span class="type">bool</span> mementar::ManagerClient::<span class="name">del</span>(const <span class="type">std::string</span>&amp; <i>name</i>)</h3>
           <p>Delete the mementar instance  named <i>name</i></p>
           <p>Returns false if the service call fails.</p>