[all] Update data comments #4751
Merged
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
hugtalbot
added
pr: status to review
hugtalbot
commented
May 22, 2024
...lidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.inl
Outdated
Show resolved
Hide resolved
alxbilger
requested changes
May 22, 2024
...tersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.cpp
Outdated
Show resolved
Hide resolved
Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.h
Outdated
Show resolved
Hide resolved
Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.inl
Outdated
Show resolved
Hide resolved
alxbilger
requested changes
May 27, 2024
Comment on lines
44
to
45
| , m1(initData(&m1, "first_point","index of the constraint on the first model (object1)")) | ||
| , m2(initData(&m2, "second_point","index of the constraint on the second model (object2)")) |
There was a problem hiding this comment.
I don't understand why you added object1 and object2 here. What information does it add?
There was a problem hiding this comment.
it was just to relate with the proper data name
| @@ -112,7 +112,7 @@ class SOFA_COMPONENT_CONTROLLER_API Controller : public core::behavior::BaseCont | |||
| Data < bool > handleEventTriggersUpdate; | |||
|
|
|||
|
|
|||
| Data< bool > d_handleEventTriggersUpdate; ///< Event reception triggers object update | |||
| Data< bool > d_handleEventTriggersUpdate; ///< Event handling frequency controls the controller update frequency | |||
There was a problem hiding this comment.
I am not comfortable with this sentence
There was a problem hiding this comment.
It appears that this data is only used in MechanicalStateController and the associated code would love to get sweeped away :
There was a problem hiding this comment.
I would recommend to create an issue and cleaning this separately (removing this useless data)
alxbilger
force-pushed
the
202405_update_data_documentation
branch
from
208983a
to
93cd786
Compare
Co-authored-by: Alex Bilger <[email protected]>
hugtalbot
commented
Jun 4, 2024
.../Lagrangian/Solver/src/sofa/component/constraint/lagrangian/solver/GenericConstraintSolver.h
Outdated
Show resolved
Hide resolved
|
[ci-build][with-all-tests] |
bakpaul
approved these changes
Jun 5, 2024
alxbilger
approved these changes
Jun 5, 2024
hugtalbot
added
pr: status ready
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.
In the context of the documentation improvement, and towards the automation of its generation, here is a first wide clean PR.
Replace #2751
By submitting this pull request, I acknowledge that
I have read, understand, and agree SOFA Developer Certificate of Origin (DCO).
Reviewers will merge this pull-request only if