Apply suggestions from code review (update descriptions)

Co-authored-by: Hugo <[email protected]>
sofa-framework · Dec 27, 2024 · 9428354 · 9428354
1 parent 82e1767
commit 9428354
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 7 deletions.
diff --git a/applications/plugins/MultiThreading/src/MultiThreading/DataExchange.cpp b/applications/plugins/MultiThreading/src/MultiThreading/DataExchange.cpp
@@ -35,7 +35,7 @@ SOFA_EVENT_CPP(DataExchangeEvent)
 
 void registerDataExchange(sofa::core::ObjectFactory* factory)
 {
-    factory->registerObjects(core::ObjectRegistrationData("DataExchange")
+    factory->registerObjects(core::ObjectRegistrationData("Component for data memory sharing in the context of multi-threading applications")
                              .add< DataExchange< sofa::type::vector<sofa::type::Vec3d> > >(true)
                              .add< DataExchange< sofa::type::vector<sofa::type::Vec2d> > >()
                              .add< DataExchange< sofa::type::vector<double> > >()

diff --git a/...tiThreading/src/MultiThreading/component/animationloop/AnimationLoopParallelScheduler.cpp b/...tiThreading/src/MultiThreading/component/animationloop/AnimationLoopParallelScheduler.cpp
@@ -41,7 +41,7 @@ namespace multithreading::component::animationloop
 
 void registerAnimationLoopParallelScheduler(sofa::core::ObjectFactory* factory)
 {
-    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel animation loop, using intel tbb library.")
+    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel animation loop, using the Intel tbb library.")
                                                           .add< AnimationLoopParallelScheduler >());
 }
 

diff --git a/...ing/src/MultiThreading/component/collision/detection/algorithm/ParallelBVHNarrowPhase.cpp b/...ing/src/MultiThreading/component/collision/detection/algorithm/ParallelBVHNarrowPhase.cpp
@@ -38,7 +38,7 @@ const bool isParallelBVHNarrowPhaseImplementationRegistered =
 
 void registerParallelBVHNarrowPhase(sofa::core::ObjectFactory* factory)
 {
-    factory->registerObjects(sofa::core::ObjectRegistrationData("Narrow phase collision detection based on boundary volume hierarchy.")
+    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel version of the narrow phase collision detection based on boundary volume hierarchy.")
                              .add< ParallelBVHNarrowPhase >());
 }
 

diff --git a/...c/MultiThreading/component/collision/detection/algorithm/ParallelBruteForceBroadPhase.cpp b/...c/MultiThreading/component/collision/detection/algorithm/ParallelBruteForceBroadPhase.cpp
@@ -36,7 +36,7 @@ const bool isParallelParallelBruteForceBroadPhaseImplementationRegistered =
 
 void registerParallelBruteForceBroadPhase(sofa::core::ObjectFactory* factory)
 {
-    factory->registerObjects(sofa::core::ObjectRegistrationData("Collision detection using extensive pair-wise tests performed in parallel.")
+    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel version of the collision detection using extensive pair-wise tests performed concurrently.")
                              .add< ParallelBruteForceBroadPhase >());
 }
 

diff --git a/...iThreading/src/MultiThreading/component/linearsolver/iterative/ParallelCGLinearSolver.cpp b/...iThreading/src/MultiThreading/component/linearsolver/iterative/ParallelCGLinearSolver.cpp
@@ -61,7 +61,7 @@ ParallelCGLinearSolver< ParallelCompressedRowSparseMatrixMechanical<sofa::type::
 
 void registerParallelCGLinearSolver(sofa::core::ObjectFactory* factory)
 {
-    factory->registerObjects(sofa::core::ObjectRegistrationData("Linear system solver using the conjugate gradient iterative algorithm in parallel.")
+    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel version of the linear solver using the conjugate gradient iterative algorithm.")
                              .add< ParallelCGLinearSolver< ParallelCompressedRowSparseMatrixMechanical<SReal>, sofa::linearalgebra::FullVector<SReal> > >(true)
                              .add< ParallelCGLinearSolver< ParallelCompressedRowSparseMatrixMechanical<sofa::type::Mat<3,3,SReal>>, sofa::linearalgebra::FullVector<SReal> > >());
 }

diff --git a/...c/MultiThreading/component/solidmechanics/fem/elastic/ParallelHexahedronFEMForceField.cpp b/...c/MultiThreading/component/solidmechanics/fem/elastic/ParallelHexahedronFEMForceField.cpp
@@ -36,7 +36,7 @@ const bool isParallelHexahedronFEMForceFieldImplementationRegistered =
 
 void registerParallelHexahedronFEMForceField(sofa::core::ObjectFactory* factory)
 {
-    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel hexahedral finite elements.")
+    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel implementation of a linear elastic material using hexahedral finite elements.")
                              .add < ParallelHexahedronFEMForceField < Vec3Types > > ());
 }
 

diff --git a/.../MultiThreading/component/solidmechanics/fem/elastic/ParallelTetrahedronFEMForceField.cpp b/.../MultiThreading/component/solidmechanics/fem/elastic/ParallelTetrahedronFEMForceField.cpp
@@ -36,7 +36,7 @@ const bool isParallelTetrahedronFEMForceFieldImplementationRegistered =
 
 void registerParallelTetrahedronFEMForceField(sofa::core::ObjectFactory* factory)
 {
-    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel tetrahedral finite elements.")
+    factory->registerObjects(sofa::core::ObjectRegistrationData("Parallel implementation of a linear elastic material using tetrahedral finite elements..")
                              .add < ParallelTetrahedronFEMForceField < Vec3Types > > ());
 }