From 9e2fc2daf251c5235d0ca36a6c680a88b539e2ca Mon Sep 17 00:00:00 2001 From: Thomas FORGIONE Date: Thu, 12 Mar 2015 11:04:53 +0100 Subject: [PATCH] Doxygen --- Code/include/Skeleton/Skeleton.hpp | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/Code/include/Skeleton/Skeleton.hpp b/Code/include/Skeleton/Skeleton.hpp index 18ef81c..d6978a7 100644 --- a/Code/include/Skeleton/Skeleton.hpp +++ b/Code/include/Skeleton/Skeleton.hpp @@ -14,6 +14,25 @@ /// \defgroup skeleton Skeleton module /// /// Module to manage 2D-skeletons +/// +/// This module contains two programs. +/// - Skeleton +/// - SkeletonDrawing +/// +/// \section Skeleton +/// This is the main binary. it takes several arguments +/// \verbatim +// Allowed options: +// -h [ --help ] produce help message +// --img1 arg first image (for the keypoints detection) +// --img2 arg second image (for the keypoints detection) +// --mask1 arg binary mask of the first image (to remove useless +// keypoints) +// --mask2 arg binary mask of the second image +// --skl1 arg first skeleton, and its branches +// --skl2 arg second skeleton +// -o [ --output ] arg output file +/// \endverbatim /////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////