Doxygen documentation2 #1573
Merged
Doxygen documentation2 #1573
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chleh
reviewed
Nov 24, 2016
| * 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 |
| @@ -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.
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.
Fixing the variable name.
chleh
approved these changes
Nov 24, 2016
| * @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.
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.
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. |
Merged
because the opening formula command is wrong.
|
OpenGeoSys development has been moved to GitLab. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
continuation of #1569 .