yade-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 3958
committer: jduriez <jerome.duriez@xxxxxxxxxxx>
timestamp: Mon 2016-10-31 11:59:22 -0600
message:
  Doc: small updates in PartialEngine and KinematicEngines
modified:
  core/PartialEngine.hpp
  pkg/common/KinematicEngines.hpp


--
lp:yade
https://code.launchpad.net/~yade-pkg/yade/git-trunk

Your team Yade developers is subscribed to branch lp:yade.
To unsubscribe from this branch go to https://code.launchpad.net/~yade-pkg/yade/git-trunk/+edit-subscription

=== modified file 'core/PartialEngine.hpp'
--- core/PartialEngine.hpp	2015-05-22 05:46:49 +0000
+++ core/PartialEngine.hpp	2016-10-31 17:59:22 +0000
@@ -14,8 +14,8 @@
 class PartialEngine: public Engine{
 	public:
 		virtual ~PartialEngine() {};
-	YADE_CLASS_BASE_DOC_ATTRS(PartialEngine,Engine,"Engine affecting only particular bodies in the simulation, defined by *ids*.",
-		((std::vector<int>,ids,,,":yref:`Ids<Body::id>` of bodies affected by this PartialEngine."))
+	YADE_CLASS_BASE_DOC_ATTRS(PartialEngine,Engine,"Engine affecting only particular bodies in the simulation, defined by :yref:`ids attribute<PartialEngine::ids>`.",
+		((std::vector<int>,ids,,,":yref:`Ids<Body::id>` list of bodies affected by this PartialEngine."))
 	);
 };
 REGISTER_SERIALIZABLE(PartialEngine);

=== modified file 'pkg/common/KinematicEngines.hpp'
--- pkg/common/KinematicEngines.hpp	2014-10-15 06:44:01 +0000
+++ pkg/common/KinematicEngines.hpp	2016-10-31 17:59:22 +0000
@@ -33,9 +33,9 @@
 struct TranslationEngine: public KinematicEngine{
 	virtual void apply(const vector<Body::id_t>& ids);
 	void postLoad(TranslationEngine&){ translationAxis.normalize(); }
-	YADE_CLASS_BASE_DOC_ATTRS(TranslationEngine,KinematicEngine,"This engine is the base class for different engines, which require any kind of motion.",
-		((Real,velocity,,,"Velocity [m/s]"))
-		((Vector3r,translationAxis,,Attr::triggerPostLoad,"Direction [Vector3]"))
+	YADE_CLASS_BASE_DOC_ATTRS(TranslationEngine,KinematicEngine,"Engine applying translation motion (by setting linear velocity) to subscribed bodies.",
+		((Real,velocity,,,"Scalar value of the imposed velocity [m/s]. Imposed vector velocity is :yref:`velocity<TranslationEngine.velocity>` * :yref:`axis<TranslationEngine.translationAxis>`"))
+		((Vector3r,translationAxis,,Attr::triggerPostLoad,"Direction of imposed translation [Vector3]"))
 	);
 };
 REGISTER_SERIALIZABLE(TranslationEngine);