Skip to content
Snippets Groups Projects
Commit c04826ea authored by Tom Fischer's avatar Tom Fischer
Browse files

fixed some doxygen warnings

parent 90814ba6
No related branches found
No related tags found
No related merge requests found
...@@ -116,7 +116,7 @@ private: ...@@ -116,7 +116,7 @@ private:
* 4 3,0,4,7 left * 4 3,0,4,7 left
* 5 4,5,6,7 top * 5 4,5,6,7 top
* @param pnt (input) coordinates of the point * @param pnt (input) coordinates of the point
* @param sqr_dists (output) squared distances of the point to the faces * @param dists (output) squared distances of the point to the faces
* ordered in the same sequence as above described * ordered in the same sequence as above described
* @param coords coordinates of the grid cell * @param coords coordinates of the grid cell
*/ */
......
...@@ -34,6 +34,10 @@ public: ...@@ -34,6 +34,10 @@ public:
* (lower left and the upper right points). * (lower left and the upper right points).
* @param ll lower left point of the square * @param ll lower left point of the square
* @param ur upper right point of the square * @param ur upper right point of the square
* @param max_points_per_node maximum number of points per node, if the
* maximum number of points per node is reached and one point more should
* be added the node will be split and the points are distributed to the
* childs of the node
*/ */
QuadTree(POINT const& ll, POINT const& ur, size_t max_points_per_node) : QuadTree(POINT const& ll, POINT const& ur, size_t max_points_per_node) :
_father (NULL), _ll (ll), _ur (ur), _depth (0), _is_leaf (true), _father (NULL), _ll (ll), _ur (ur), _depth (0), _is_leaf (true),
...@@ -370,6 +374,9 @@ private: ...@@ -370,6 +374,9 @@ private:
* @param ur upper right point * @param ur upper right point
* @param father father in the tree * @param father father in the tree
* @param depth depth of the node * @param depth depth of the node
* @param max_points_per_node maximum number of points per node, if the
* maximum number of points per node is reached and one point more should
* be added the node will be split and the points are distributed to the
* @return * @return
*/ */
QuadTree (POINT const& ll, POINT const& ur, QuadTree* father, size_t depth, size_t max_points_per_node) : QuadTree (POINT const& ll, POINT const& ur, QuadTree* father, size_t depth, size_t max_points_per_node) :
......
...@@ -73,7 +73,6 @@ public: ...@@ -73,7 +73,6 @@ public:
* \param y The y-coordinate of the station. * \param y The y-coordinate of the station.
* \param z The z-coordinate of the station. * \param z The z-coordinate of the station.
* \param name The name of the station. * \param name The name of the station.
* \param color The color of the station in visualisation.
*/ */
Station(double x = 0.0, Station(double x = 0.0,
double y = 0.0, double y = 0.0,
...@@ -117,7 +116,11 @@ public: ...@@ -117,7 +116,11 @@ public:
/// Determines if the station's parameters are within the the bounds of the current selection (see property system for details) /// Determines if the station's parameters are within the the bounds of the current selection (see property system for details)
bool inSelection(const std::vector<PropertyBounds> &bounds); bool inSelection(const std::vector<PropertyBounds> &bounds);
/// Returns true if all properties of this stations are within the boundaries given by \param bounds and false otherwise /**
* Returns true if all properties of this stations are within the boundaries given by bounds and false otherwise
* @param properties the bounds
* @return true if all properties of this stations are within the boundaries, else false
*/
bool inSelection(std::map<std::string, double> properties) const; bool inSelection(std::map<std::string, double> properties) const;
/// Returns the name of the station. /// Returns the name of the station.
......
...@@ -80,7 +80,7 @@ void crossProd (const double u[3], const double v[3], double r[3]); ...@@ -80,7 +80,7 @@ void crossProd (const double u[3], const double v[3], double r[3]);
/** /**
* calcProjPntToLineAndDists computes the orthogonal projection * calcProjPntToLineAndDists computes the orthogonal projection
* of a point p to the line described by the points a and b, * of a point p to the line described by the points a and b,
* $g(\lambda) = a + \lambda (b - a)$, * \f$g(\lambda) = a + \lambda (b - a)\f$,
* the distance between p and the projected point * the distance between p and the projected point
* and the distances between the projected point and the end * and the distances between the projected point and the end
* points a, b of the line * points a, b of the line
......
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