Merge pull request #172 from SimonRohou/codac2_dev

Solving Doxygen issue with template specializations
codac-team · Jan 8, 2025 · 50664bf · 50664bf
2 parents 519a690 + 04a7233
commit 50664bf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/examples/04_explored_area/main.cpp b/examples/04_explored_area/main.cpp
@@ -19,12 +19,12 @@ int main()
 
   Interval tdomain(0,5);
   auto sampled_f = AnalyticTrajectory(f,tdomain).sampled(0.8);
-  sampled_f[6] = {0,-1};
+  sampled_f[6] = {0,-1}; // appending the position (0,-1) at t=6
 
   VectorVar w(3);
   auto g = sampled_f.as_function();
   AnalyticFunction h {
-    {w},
+    {w}, // w=(t,x,y)
     sqr(w[0]-g(w[2])[0])+sqr(w[1]-g(w[2])[1])
   };
 

diff --git a/examples/04_explored_area/main.py b/examples/04_explored_area/main.py
@@ -15,12 +15,12 @@
 
 tdomain = [0,5]
 sampled_f = AnalyticTrajectory(f,tdomain).sampled(0.8)
-sampled_f[6] = [0,-1]
+sampled_f[6] = [0,-1] # appending the position (0,-1) at t=6
 
 w = VectorVar(3)
 g = sampled_f.as_function()
 h = AnalyticFunction(
-  [w],
+  [w], # w=(t,x,y)
   sqr(w[0]-g(w[2])[0])+sqr(w[1]-g(w[2])[1])
 )
 

diff --git a/src/core/separators/codac2_SepWrapper.h b/src/core/separators/codac2_SepWrapper.h
@@ -16,6 +16,8 @@
 
 namespace codac2
 {
+  /// \cond SepWrapper_<T>
+
   template<typename T>
   class SepWrapper_ : public Sep<SepWrapper_<T>>
   {
@@ -30,6 +32,8 @@ namespace codac2
       const T _y;
   };
 
+  /// \endcond
+
   template<>
   class SepWrapper_<IntervalVector> : public SepCtcPair
   {