diff --git a/GeoLib/Grid.h b/GeoLib/Grid.h index b799c9e4ebd11d5d3b7537c0e7ab523cb6570aca..2d35e7852eb8898f893748d5cbe9c258f5b80b9d 100644 --- a/GeoLib/Grid.h +++ b/GeoLib/Grid.h @@ -116,7 +116,7 @@ private: * 4 3,0,4,7 left * 5 4,5,6,7 top * @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 * @param coords coordinates of the grid cell */ diff --git a/GeoLib/QuadTree.h b/GeoLib/QuadTree.h index f6b2c7222af4945befbda4f71d3380e39e278727..b82f4aa9d537f0a267fd67f953dbfbcd6f342c60 100644 --- a/GeoLib/QuadTree.h +++ b/GeoLib/QuadTree.h @@ -34,6 +34,10 @@ public: * (lower left and the upper right points). * @param ll lower left 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) : _father (NULL), _ll (ll), _ur (ur), _depth (0), _is_leaf (true), @@ -370,6 +374,9 @@ private: * @param ur upper right point * @param father father in the tree * @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 */ QuadTree (POINT const& ll, POINT const& ur, QuadTree* father, size_t depth, size_t max_points_per_node) : diff --git a/GeoLib/Station.h b/GeoLib/Station.h index 032695a5f063a5c501e855953c66b226ed742ade..b05d5daea16bb8c90c4380087288dbeff32b48b8 100644 --- a/GeoLib/Station.h +++ b/GeoLib/Station.h @@ -73,7 +73,6 @@ public: * \param y The y-coordinate of the station. * \param z The z-coordinate of the station. * \param name The name of the station. - * \param color The color of the station in visualisation. */ Station(double x = 0.0, double y = 0.0, @@ -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) 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; /// Returns the name of the station. diff --git a/MathLib/MathTools.h b/MathLib/MathTools.h index 15c51df5693ada1b82e78d079941b1d0a5f8c49d..b1d046c7a5091e0a52c2aea490b2656bd6ada38e 100644 --- a/MathLib/MathTools.h +++ b/MathLib/MathTools.h @@ -80,7 +80,7 @@ void crossProd (const double u[3], const double v[3], double r[3]); /** * calcProjPntToLineAndDists computes the orthogonal projection * 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 * and the distances between the projected point and the end * points a, b of the line