-
Notifications
You must be signed in to change notification settings - Fork 239
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doxygen documentation2 #1573
Doxygen documentation2 #1573
Conversation
* Splits a string into a vector of strings. This method only works for string seperation | ||
* recognised by the std::stringstream iterator such as ' ' or '\t'. | ||
* Splits a string into a vector of strings. This method only works for string | ||
* seperation recognised by the std::stringstream iterator such as ' ' or |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo separation ✅
@@ -86,6 +86,8 @@ class OctTree { | |||
/// private constructor | |||
/// @param ll lower left point | |||
/// @param ur upper right point | |||
/// @param eps the euclidean distance as a threshold to make objects unique | |||
/// [default std::numeric_limits<double>::epsilon()] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is the default set? The method declaration does not declare a default value.
✅
@@ -46,6 +46,7 @@ template <typename POINT> class QuadTree | |||
* (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 leaf |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
node vs. leaf?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixing the variable name.
* @param eps tolerance for numerical algorithm used or computing the property | ||
* @return true if the point is not outside the element, false otherwise | ||
* \copydoc MeshLib::Element::isPntInElement() | ||
* @param nodes the nodes of the element. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You only document one parameter. Are the other parameter docs inherited by copydoc?
Smiliar for the other isPntInElement()
methods.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. Other parameters docs are copied (probably must have exactly the same types and names, which they do). Only extra parameters needs documentation.
Just recognized that some of my comments acutally apply to #1569. |
a3ce861
to
b5517d5
Compare
because the opening formula command is wrong.
b5517d5
to
5cc4b2b
Compare
OpenGeoSys development has been moved to GitLab. |
continuation of #1569 .