Changeset 7334 in orxonox.OLD for trunk

Timestamp:

Apr 18, 2006, 8:47:10 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxy

Location:

trunk/src/lib/particles

Files:

• particle_system.cc (modified) (1 diff)
• quick_animation.cc (modified) (2 diffs)
• quick_animation.h (modified) (2 diffs)

trunk/src/lib/particles/particle_system.cc

@@ -279 +279 @@
 
   PRINTF(4)("Precaching %s::%s %d seconds %d timesPerSecond\n", this->getClassName(), this->getName(), seconds, ticksPerSecond);
-  this->debug();
   for (unsigned int i = 0; i < seconds*ticksPerSecond; i++)
     this->tick(1.0/(float)ticksPerSecond);

trunk/src/lib/particles/quick_animation.cc

@@ -288 +288 @@
 
 
-
+/**
+ * @brief compares two QuickKeyFrames with their positions.
+ * @param key1 the first keyframe
+ * @param key2 the second keyframe
+ * @returns true, if the key1.position < key2.position.
+ */
 bool QuickAnimation::QuickKeyFrame::sortPositionPredicate(const QuickKeyFrame& key1, const QuickKeyFrame& key2)
 {
@@ -294 +299 @@
 }
 
+/**
+ * @brief compares two QuickKeyFrames with their values.
+ * @param key1 the first keyframe
+ * @param key2 the second keyframe
+ * @returns true, if the key1.value < key2.value.
+ */
 bool QuickAnimation::QuickKeyFrame::sortValuePredicate(const QuickKeyFrame& key1, const QuickKeyFrame& key2)
 {

trunk/src/lib/particles/quick_animation.h

@@ -48 +48 @@
   }
 
-/**
+  /**
    * @brief returns the value of the animation at a certain position
    * @param position the position to get the value from :)
    * @returns the calculated Value.
- */
+   */
   float QuickAnimation::getValue(float position) const
   {
@@ -59 +59 @@
 
   void debug() const;
+
 private:
   void rebuild();