Filled out mainpage.dox

OrebroUniversity · Dec 27, 2013 · 2653b2a · 2653b2a
1 parent c0c9a8d
commit 2653b2a
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/industrial_trajectory_filters/mainpage.dox b/industrial_trajectory_filters/mainpage.dox
@@ -2,13 +2,13 @@
 \mainpage
 \htmlinclude manifest.html
 
-\b industrial_trajectory_filters 
+\b industrial_trajectory_filters provides robot trajectory filters.  It also includes plugin adapters for the moveit motion planning library.
 
-<!-- 
-Provide an overview of your package.
--->
-
--->
 
+\section codeapi Code API
 
+The main APIs of are largely captured in the following interface classes:
+- industrial_trajectory_filters::NPointFilter : A simple filter that removes trajectory points until the trajectory is N or less points
+- industrial_trajectory_filters::UniformSampleFilter : Resamples a trajectory uniformly (in time).
+- industrial_trajectory_filters::FilterBase : A <a href="http://moveit.ros.org">moveit</a>  adapter class for old <a href="http://wiki.ros.org/arm_navigation">arm navigation</a> packages.
 */