Skip to content
Snippets Groups Projects
Commit f35b1300 authored by Joan Solà Ortega's avatar Joan Solà Ortega
Browse files

Improved parameter documentation. Removed Markdown support for Doxygen

parent 0587c234
No related branches found
No related tags found
No related merge requests found
......@@ -291,7 +291,7 @@ EXTENSION_MAPPING =
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
MARKDOWN_SUPPORT = NO
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
......
......@@ -62,10 +62,9 @@ class AssociationNNLS : public AssociationSolver
/** \brief Solves the problem
*
* Solves the asscoiation problem followinf nearest neighbor linear search
* Solves the association problem following nearest neighbor linear search.
* Return values are:
* \param _pairs Returned pairs: vector of pairs (d_i, t_j)
* \param _unassoc Returned unassociated detections: vector of (d_i)
* \param _associated_mask Resized to nd_. Marks true at i if detection d_i has been associated, otherwise marks false
*
* Assumes i/j_mask_ vector class members and scores_ matrix are correctly sized, by a previous call to resize()
......
......@@ -108,6 +108,8 @@ class AssociationNode
/** \brief Computes node probability
*
* Computes probability that detection_i associates to target_j, given the scores table _stab.
* \param _nd TODO document this
* \param _nt TODO document this
* \param _di detection index (not id)
* \param _tj target index (not id)
* \param _stab score table
......@@ -139,9 +141,11 @@ class AssociationNode
/** \brief Grows tree recursively
*
* Grows tree recursively according the association probability table provided
* \param _nd
* \param _nt
* \param _det_i: detection index
* \param _p_tab: table of association probabilities between detections and targets
* \param _ex_vec: vector of target index for which the tree should not continue growing
* \param _stab: table of association probabilities between detections and targets
* \param _excluded: vector of target index for which the tree should not continue growing
*
**/
//void growTree(const unsigned int _nd, const unsigned int _nt, const unsigned int _det_i, const std::vector< std::vector<double> > & _stab, std::vector<unsigned int> & _excluded);
......
......@@ -86,7 +86,6 @@ class AssociationSolver
* Solves and sets decision pairs
* Return values are:
* \param _pairs Returned pairs: vector of pairs (d_i, t_j)
* \param _unassoc Returned unassociated detections: vector of (d_i)
* \param _associated_mask Resized to nd_. Marks true at i if detection d_i has been associated, otherwise marks false
*
**/
......
......@@ -92,11 +92,19 @@ class AssociationTree : public AssociationSolver
* Decides best hypothesis according tree computation made by computeTree()
* Return values are:
* \param _pairs Returned pairs: vector of pairs (d_i, t_j)
* \param _unassoc Returned unassociated detections: vector of (d_i)
* \param _associated_mask Resized to nd_. Marks true at i if detection d_i has been associated, otherwise marks false
*
**/
void solve(std::map<unsigned int, unsigned int> & _pairs, std::vector<bool> & _associated_mask);
/** \brief Gets tree decision
*
* Decides best hypothesis according tree computation made by computeTree()
* Return values are:
* \param _pairs Returned pairs: vector of pairs (d_i, t_j)
* \param _associated_mask Resized to nd_. Marks true at i if detection d_i has been associated, otherwise marks false
*
**/
void solve(std::vector<std::pair<unsigned int, unsigned int> > & _pairs, std::vector<bool> & _associated_mask);
/** \brief Prints the tree
......
......@@ -52,8 +52,10 @@ class LandmarkContainer : public LandmarkBase
* Constructor with type, and state pointer
* \param _p_ptr StateBase pointer to the position
* \param _o_ptr StateBase pointer to the orientation
* \param _corner_1_ptr LandmarkCorner2D pointer to one of its corners
* \param _corner_2_ptr LandmarkCorner2D pointer to one of its corners
* \param _corner_A_ptr LandmarkCorner2D pointer to one of its corners
* \param _corner_B_ptr LandmarkCorner2D pointer to one of its corners
* \param _corner_C_ptr LandmarkCorner2D pointer to one of its corners
* \param _corner_D_ptr LandmarkCorner2D pointer to one of its corners
* \param _witdh descriptor of the landmark: container width
* \param _length descriptor of the landmark: container length
*
......
......@@ -22,9 +22,8 @@ class LandmarkCorner2D : public LandmarkBase
/** \brief Constructor with type, time stamp and the position state pointer
*
* Constructor with type, and state pointer
* \param _tp indicates frame type. Generally either REGULAR_FRAME or KEY_FRAME. (types defined at wolf.h)
* \param _p_ptr StateBase shared pointer to the position
* \param _p_ptr StateBase shared pointer to the position
* \param _o_ptr StateBase shared pointer to the orientation
* \param _aperture descriptor of the landmark: aperture of the corner
*
**/
......
......@@ -26,7 +26,6 @@ class SensorLaser2D : public SensorBase
* Constructor with arguments
* \param _p_ptr StateBase pointer to the sensor position
* \param _o_ptr StateBase pointer to the sensor orientation
* \param _params struct with scan parameters. See laser_scan_utils library API for reference
*
**/
SensorLaser2D(StateBlock* _p_ptr, StateBlock* _o_ptr);
......@@ -54,7 +53,7 @@ class SensorLaser2D : public SensorBase
/** \brief Set corner detection algorithm parameters
*
* Set corner detection algorithm parameters
* \param _params struct with corner detection algorithm parameters. See laser_scan_utils library API for reference.
* \param _corner_alg_params struct with corner detection algorithm parameters. See laser_scan_utils library API for reference.
*
**/
void setCornerAlgParams(const laserscanutils::ExtractCornerParams & _corner_alg_params);
......
......@@ -25,6 +25,7 @@ class StateBlock
* Constructor with scalar pointer
* \param _state is state vector
* \param _type parametrization of the state
* \param _fixed Indicates this state is not estimated and thus acts as a fixed parameter
*
**/
StateBlock(const Eigen::VectorXs _state, StateType _type = ST_VECTOR, bool _fixed = false);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment