Merge pull request #239 from blackberry-gaming/next-setaylor

Next setaylor

gameplay/src/AbsoluteLayout.h

@@ -44,9 +44,20 @@ protected:
     void update(const Container* container);
 
 private:
-
+    
+    /*
+     * Constructor.
+     */
     AbsoluteLayout();
+    
+    /*
+     * Constructor.
+     */
     AbsoluteLayout(const AbsoluteLayout& copy);
+    
+    /*
+     * Destructor.
+     */
     virtual ~AbsoluteLayout();
 };
 

gameplay/src/AnimationClip.h

@@ -36,6 +36,9 @@ public:
 
     public:
 
+        /*
+         * Constructor.
+         */
         Listener() 
         {
         }
@@ -225,9 +228,7 @@ public:
     void addListener(AnimationClip::Listener* listener, unsigned long eventTime);
 
 private:
-    /**
-     * State bits.
-     */
+    
     static const unsigned char CLIP_IS_PLAYING_BIT = 0x01;             // Bit representing whether AnimationClip is a running clip in AnimationController
     static const unsigned char CLIP_IS_STARTED_BIT = 0x02;             // Bit representing whether the AnimationClip has actually been started (ie: received first call to update())
     static const unsigned char CLIP_IS_FADING_OUT_STARTED_BIT = 0x04;  // Bit representing that a cross fade has started.

gameplay/src/AnimationController.h

@@ -28,6 +28,9 @@ public:
        
 private:
 
+    /**
+     * The states that the AnimationController may be in.
+     */
     enum State
     {
         RUNNING,

gameplay/src/AnimationTarget.h

@@ -152,6 +152,9 @@ public:
 
 protected:
     
+    /**
+     * The type of animation target. 
+     */
     enum TargetType
     {
         SCALAR,
@@ -197,9 +200,8 @@ protected:
      */
     void cloneInto(AnimationTarget* target, NodeCloneContext &context) const;
 
-    TargetType _targetType;             // The type of target this is.
-
-    unsigned char _animationPropertyBitFlag;     // Bit flag used to indicate which properties on the AnimationTarget are currently animating.
+    TargetType _targetType;                     // The type of target this is.
+    unsigned char _animationPropertyBitFlag;    // Bit flag used to indicate which properties on the AnimationTarget are currently animating.
 
 private:
 

gameplay/src/AudioBuffer.h

@@ -11,13 +11,14 @@ class AudioSource;
 /**
  * The actual audio buffer data.
  *
- * Currently only supports OpenAL supported formats: .wav, .au and .raw files.
+ * Currently only supports supported formats: .wav, .au and .raw files.
  */
 class AudioBuffer : public Ref
 {
     friend class AudioSource;
 
 private:
+    
 #ifndef __ANDROID__
     /**
      * Constructor.

gameplay/src/AudioSource.h

@@ -152,16 +152,13 @@ private:
      * Constructor that takes an AudioBuffer.
      */
     AudioSource(AudioBuffer* buffer, ALuint source);
-
 #else
-
     /**
      * Constructor that takes an AudioBuffer.
      */
     AudioSource(AudioBuffer* buffer, const SLObjectItf& player);
 #endif
 
-
     /**
      * Destructor.
      */

gameplay/src/Base.h

@@ -168,7 +168,6 @@ extern void printError(const char* format, ...);
 #include <SLES/OpenSLES.h>
 #include <SLES/OpenSLES_Android.h>
 #else
-
 #ifdef __QNX__
 #include <AL/al.h>
 #include <AL/alc.h>
@@ -179,7 +178,6 @@ extern void printError(const char* format, ...);
 #include <OpenAL/al.h>
 #include <OpenAL/alc.h>
 #endif
-
 #include <vorbis/vorbisfile.h>
 #endif
 

gameplay/src/Button.h

@@ -10,7 +10,7 @@ namespace gameplay
 {
 
 /**
- * Defines a button UI control.  This is essentially a label that can have a callback method set on it.
+ * Defines a button UI control. This is essentially a label that can have a callback method set on it.
  *
  * The following properties are available for buttons:
  *
@@ -64,6 +64,9 @@ protected:
 
 private:
 
+    /*
+     * Constructor.
+     */
     Button(const Button& copy);
 };
 

gameplay/src/Camera.h

@@ -250,7 +250,6 @@ private:
      * Clones the camera and returns a new camera.
      * 
      * @param context The clone context.
-     * 
      * @return The newly created camera.
      */
     Camera* clone(NodeCloneContext &context) const;

gameplay/src/CheckBox.h

@@ -16,7 +16,7 @@ namespace gameplay
  *
  * checkBox <checkBoxID>
  * {
- *      style       = <Style ID>
+ *      style       = <styleID>
  *      position    = <x, y>
  *      size        = <width, height>
  *      text        = <string>
@@ -121,6 +121,9 @@ protected:
 
 private:
 
+    /*
+     * Constructor.
+     */
     CheckBox(const CheckBox& copy);
 };
 

gameplay/src/Container.h

@@ -12,23 +12,26 @@ namespace gameplay
  *
  * The following properties are available for containers:
  *
- * container <Container ID>
+ * container <containerID>
  * {
  *      // Container properties.
- *      layout   = <Layout Type>        // A value from the Layout::Type enum.  E.g.: LAYOUT_VERTICAL
- *      style    = <Style ID>           // A style from the form's theme.
+ *      layout   = <Layout::Type>        // A value from the Layout::Type enum.  E.g.: LAYOUT_VERTICAL
+ *      style    = <styleID>           // A style from the form's theme.
  *      position = <x, y>               // Position of the container on-screen, measured in pixels.
  *      size     = <width, height>      // Size of the container, measured in pixels.
  *   
  *      // All the nested controls within this container.
- *      container { }
-
+ *      container 
+ *      { 
+ *          ...
+ *      }
+ * 
  *      label { }
  *      textBox { }
- *      button{}
- *      checkBox{}
- *      radioButton{}
- *      slider{}
+ *      button { }
+ *      checkBox { }
+ *      radioButton { }
+ *      slider { }
  * }
  */
 class Container : public Control

gameplay/src/Control.h

@@ -722,23 +722,35 @@ protected:
 
 private:
 
-    // Animation blending bits.
     static const char ANIMATION_POSITION_X_BIT = 0x01;
     static const char ANIMATION_POSITION_Y_BIT = 0x02;
     static const char ANIMATION_SIZE_WIDTH_BIT = 0x04;
     static const char ANIMATION_SIZE_HEIGHT_BIT = 0x08;
     static const char ANIMATION_OPACITY_BIT = 0x10;
 
-    bool _styleOverridden;
-
+    /*
+     * Constructor.
+     */    
+    Control(const Control& copy);
+    
     void applyAnimationValuePositionX(float x, float blendWeight);
+    
     void applyAnimationValuePositionY(float y, float blendWeight);
+    
     void applyAnimationValueSizeWidth(float width, float blendWeight);
+    
     void applyAnimationValueSizeHeight(float height, float blendWeight);
+    
     void applyAnimationValueOpacity();
 
-    Control(const Control& copy);
+    Theme::Style::Overlay** getOverlays(unsigned char overlayTypes, Theme::Style::Overlay** overlays);
 
+    Theme::Style::Overlay* getOverlay(Control::State state) const;
+
+    void overrideStyle();
+    
+    void addSpecificListener(Control::Listener* listener, Listener::EventType eventType);
+    
     /**
      * Draws the themed border and background of a control.
      *
@@ -746,19 +758,8 @@ private:
      * @param clip The clipping rectangle of this control's parent container.
      */
     virtual void drawBorder(SpriteBatch* spriteBatch, const Rectangle& clip);
-
-    void addSpecificListener(Control::Listener* listener, Listener::EventType eventType);
-
-    // Gets the overlays requested in the overlayTypes bitflag.
-    Theme::Style::Overlay** getOverlays(unsigned char overlayTypes, Theme::Style::Overlay** overlays);
-
-    /**
-     * Gets an overlay from a control state.
-     */
-    Theme::Style::Overlay* getOverlay(Control::State state) const;
-
-    // Ensures that this control has a copy of its style so that it can override it without affecting other controls.
-    void overrideStyle();
+    
+    bool _styleOverridden;
 };
 
 }

gameplay/src/Curve.h

@@ -401,7 +401,7 @@ private:
     Curve(unsigned int pointCount, unsigned int componentCount);
 
     /**
-     * Hidden copy constructor.
+     * Constructor.
      */
     Curve(const Curve& copy);
 
@@ -411,7 +411,7 @@ private:
     ~Curve();
 
     /**
-     * Hidden copy assignment operator.
+     * Copy assignment operator.
      */
     Curve& operator=(const Curve&);
 

gameplay/src/DebugNew.h

@@ -90,6 +90,7 @@ T* bullet_new(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8, T9 t9)
 }
 
 #if defined(WIN32)
+
 /**
  * Sets whether stack traces are tracked on memory allocations or not.
  * 

gameplay/src/FlowLayout.h

@@ -6,16 +6,39 @@
 namespace gameplay
 {
 
+/**
+ *  Defines a Layout for forms and containers that arranges controls 
+ * in a left-to-right(default) or right-to-left flow.
+ */
 class FlowLayout : public Layout
 {
 public:
+
+    /**
+     * Constructor.
+     */
     static FlowLayout* create();
 
+    /**
+     * Sets if the layout is left-to-right or right to left.
+     */
     void setRightToLeft(bool rightToLeft);
 
 private:
+    
+    /**
+     * Constructor.
+     */
     FlowLayout();
+    
+    /**
+     * Constructor.
+     */
     FlowLayout(const FlowLayout& copy);
+    
+    /**
+     * Destructor.
+     */
     virtual ~FlowLayout();
 };
 

gameplay/src/Font.h

@@ -202,7 +202,7 @@ private:
     Font();
 
     /**
-     * Copy constructor.
+     * Constructor.
      */
     Font(const Font& copy);
 
@@ -211,16 +211,13 @@ private:
      */
     ~Font();
 
-    // Used by both getIndexAtLocation and getLocationAtIndex.
     unsigned int getIndexOrLocation(const char* text, const Rectangle& clip, unsigned int size, const Vector2& inLocation, Vector2* outLocation,
                                     const int destIndex = -1, Justify justify = ALIGN_TOP_LEFT, bool wrap = true, bool rightToLeft = false);
 
-    // Utilities
     unsigned int getTokenWidth(const char* token, unsigned int length, unsigned int size, float scale);
 
     unsigned int getReversedTokenLength(const char* token, const char* bufStart);
 
-    // Returns 0 if EOF was reached, 1 if delimiters were handles correctly, and 2 if the stopAtPosition was reached while handling delimiters.
     int handleDelimiters(const char** token, const unsigned int size, const int iteration, const int areaX, int* xPos, int* yPos, unsigned int* lineLength,
                          std::vector<int>::const_iterator* xPositionsIt, std::vector<int>::const_iterator xPositionsEnd, unsigned int* charIndex = NULL,
                          const Vector2* stopAtPosition = NULL, const int currentIndex = -1, const int destIndex = -1);

gameplay/src/Form.h

@@ -27,17 +27,20 @@ public:
      * Create from properties file.
      * The top-most namespace in the file must be named 'form'.  The following properties are available for forms:
      *
-     * form <Form ID>
+     * form <formID>
      * {
      *      // Form properties.
-     *      theme    = <Path to Theme File> // See Theme.h.
-     *      layout   = <Layout Type>        // A value from the Layout::Type enum.  E.g.: LAYOUT_VERTICAL
-     *      style    = <Style ID>           // A style from the referenced theme.
-     *      position = <x, y>               // Position of the form on-screen, measured in pixels.
-     *      size     = <width, height>      // Size of the form, measured in pixels.
+     *      theme    = <Path to .theme File>    // See Theme.h.
+     *      layout   = <Layout::Type>           // A value from the Layout::Type enum.  e.g.: LAYOUT_VERTICAL
+     *      style    = <styleID>                // A style from the referenced theme.
+     *      position = <x, y>                   // Position of the form on-screen, measured in pixels.
+     *      size     = <width, height>          // Size of the form, measured in pixels.
      *   
-     *      // All the controls within this form.
-     *      container { }
+     *      // All the nested controls within this form.
+     *      container 
+     *      {
+     *          ...
+     *      }
      *      label { }
      *      textBox { }
      *      button { }

gameplay/src/FrameBuffer.h

@@ -99,10 +99,13 @@ public:
      
 private:
  
+    /**
+     * Constructor.
+     */
     FrameBuffer(const char* id);
 
     /**
-     * Destructor.  Removes this FrameBuffer from the list of available FrameBuffers.
+     * Destructor.
      */
     ~FrameBuffer();
 

gameplay/src/Joint.h

@@ -77,12 +77,12 @@ protected:
 private:
 
     /**
-     * Hidden copy constructor.
+     * Constructor.
      */
     Joint(const Joint& copy);
 
     /**
-     * Hidden copy assignment operator.
+     * Copy assignment operator.
      */
     Joint& operator=(const Joint&);
 

gameplay/src/Label.h

@@ -12,9 +12,9 @@ namespace gameplay
  *
  * The following properties are available for labels:
  *
- * label <Label ID>
+ * label <labelID>
  * {
- *      style       = <Style ID>
+ *      style       = <styleID>
  *      position    = <x, y>
  *      size        = <width, height>
  *      text        = <string>
@@ -90,6 +90,9 @@ protected:
 
 private:
 
+    /**
+     * Constructor.
+     */
     Label(const Label& copy);
 };
 

gameplay/src/Light.h

@@ -12,7 +12,6 @@ class NodeCloneContext;
 
 /**
  * Defines a light.
- *
  */
 class Light : public Ref
 {
@@ -30,7 +29,6 @@ public:
         SPOT = 3
     };
 
-
     /**
      * Creates a directional light.
      * 
@@ -158,7 +156,6 @@ public:
      */
     float getOuterAngleCos() const;
 
-
 private:
 
     /**
@@ -234,6 +231,7 @@ private:
     Light* clone(NodeCloneContext &context) const;
 
     Light::Type _type;
+    
     union
     {
         Directional* _directional;

gameplay/src/Material.h

@@ -134,14 +134,14 @@ private:
     Material();
 
     /**
-     * Destructor.
+     * Constructor.
      */
-    ~Material();
-
+    Material(const Material& m);
+    
     /**
-     * Hidden copy constructor.
+     * Destructor.
      */
-    Material(const Material& m);
+    ~Material();
 
     /**
      * Loads a technique from the given properties object into the specified material.

gameplay/src/MaterialParameter.h

@@ -168,6 +168,18 @@ public:
 
 private:
 
+    static const char ANIMATION_UNIFORM_BIT = 0x01;
+    
+    /**
+     * Constructor.
+     */
+    MaterialParameter(const char* name);
+    
+    /**
+     * Destructor.
+     */
+    ~MaterialParameter();
+    
     /**
      * Interface implemented by templated method bindings for simple storage and iteration.
      */
@@ -218,20 +230,14 @@ private:
         CountMethod _countMethod;
     };
 
-    /**
-     * Constructor.
-     */
-    MaterialParameter(const char* name);
-
-    /**
-     * Destructor.
-     */
-    ~MaterialParameter();
-
     void clearValue();
 
     void bind(Effect* effect);
 
+    void applyAnimationValue(AnimationValue* value, float blendWeight, int components);
+
+    void cloneInto(MaterialParameter* materialParameter) const;
+    
     union
     {
         float floatValue;
@@ -241,7 +247,7 @@ private:
         const Texture::Sampler* samplerValue;
         MethodBinding* method;
     } _value;
-
+    
     enum
     {
         NONE,
@@ -254,18 +260,7 @@ private:
         SAMPLER,
         METHOD
     } _type;
-
-    static const char ANIMATION_UNIFORM_BIT = 0x01;
-
-    void applyAnimationValue(AnimationValue* value, float blendWeight, int components);
-
-    /**
-     * Copies the data from this MaterialParameter into the given MaterialParameter.
-     * 
-     * @param materialParameter The MaterialParameter to copy the data to.
-     */
-    void cloneInto(MaterialParameter* materialParameter) const;
-
+    
     unsigned int _count;
     bool _dynamic;
     std::string _name;

gameplay/src/Mesh.h

@@ -299,8 +299,6 @@ private:
 
     /**
      * Constructor.
-     *
-     * @param copy The mesh to copy from.
      */
     Mesh(const Mesh& copy);
 

gameplay/src/MeshBatch.h

@@ -111,8 +111,14 @@ public:
 
 private:
 
+    /**
+     * Constructor.
+     */
     MeshBatch(const VertexFormat& vertexFormat, Mesh::PrimitiveType primitiveType, Material* material, bool indexed, unsigned int initialCapacity, unsigned int growSize);
 
+    /**
+     * Constructor.
+     */
     MeshBatch(const MeshBatch& copy);
 
     void updateVertexAttributeBinding();

gameplay/src/MeshSkin.h

@@ -117,7 +117,7 @@ private:
     MeshSkin();
 
     /**
-     * Hidden copy constructor.
+     * Constructor.
      */
     MeshSkin(const MeshSkin&);
 
@@ -127,7 +127,7 @@ private:
     ~MeshSkin();
     
     /**
-     * Hidden copy assignment operator.
+     * Copy assignment operator.
      */
     MeshSkin& operator=(const MeshSkin&);
 
@@ -169,6 +169,7 @@ private:
     Matrix _bindShape;
     std::vector<Joint*> _joints;
     Joint* _rootJoint;
+    
     // Pointer to the root node of the mesh skin.
     // The purpose is so that the joint hierarchy doesn't need to be in the scene.
     // If the joints are not in the scene then something has to hold a reference to it.

gameplay/src/Model.h

@@ -182,7 +182,6 @@ private:
      * Clones the model and returns a new model.
      * 
      * @param context The clone context.
-     * 
      * @return The new cloned model.
      */
     Model* clone(NodeCloneContext &context);

gameplay/src/Slider.h

@@ -16,15 +16,16 @@ namespace gameplay
  *
  *  slider
  *  {
- *      style       = <Style ID>                // A Style from the Theme.
+ *      style       = <styleID>                 // A Style from the Theme.
  *      position    = <x, y>                    // Position of the Control on-screen, measured in pixels.
  *      size        = <width, height>           // Size of the Control, measured in pixels.
- *      // TODO: orientation = <HORIZONTAL or VERTICAL>  // Determines whether a slider is stretched along its width or its height
  *      min         = <float>                   // The value of the left- / bottom-most point on the slider.
  *      max         = <float>                   // The value of the right- / top-most point on the slider.
  *      value       = <float>                   // The default position of the marker.
  *      step        = <float>                   // If greater than 0, force the marker to snap to discrete multiples of 'step'.
  *      text        = <string>                  // Text to display above, below or alongside the slider (depending on the style).
+ *
+*      // TODO: orientation = <HORIZONTAL or VERTICAL>  // Determines whether a slider is stretched along its width or its height
  *  }
  */
 class Slider : public Label
@@ -154,6 +155,9 @@ protected:
 
 private:
 
+    /**
+     * Constructor.
+     */
     Slider(const Slider& copy);
 };
 

gameplay/src/TextBox.h

@@ -18,9 +18,9 @@ namespace gameplay
  *
  * The following properties are available for text boxes:
  *
- * label <Label ID>
+ * label <labelID>
  * {
- *      style       = <Style ID>
+ *      style       = <styleID>
  *      position    = <x, y>
  *      size        = <width, height>
  *      text        = <string>
@@ -121,6 +121,9 @@ protected:
 
 private:
 
+    /**
+     * Constructor.
+     */
     TextBox(const TextBox& copy);
 
     void setCaretLocation(int x, int y);

gameplay/src/VertexFormat.h

@@ -90,7 +90,7 @@ public:
     };
 
     /**
-     * Constructs a new vertex format for the requested vertex element layout.
+     * Constructor.
      *
      * The passed in element array is copied into the new VertexFormat.
      *
@@ -105,21 +105,21 @@ public:
     ~VertexFormat();
 
     /**
-     * Returns the vertex element at the specified index.
+     * Gets the vertex element at the specified index.
      *
-     * index The index of the element to retreive.
+     * @param index The index of the element to retreive.
      */
     const Element& getElement(unsigned int index) const;
 
     /**
-     * Returns the number of elements in this VertexFormat.
+     * Gets the number of elements in this VertexFormat.
      *
      * @return The number of items in the elements array.
      */
     unsigned int getElementCount() const;
 
     /**
-     * Returns the size (in bytes) of a single vertex using this format.
+     * Gets the size (in bytes) of a single vertex using this format.
      */
     unsigned int getVertexSize() const;
 

gameplay/src/VerticalLayout.h

@@ -73,6 +73,9 @@ protected:
 
 private:
 
+    /**
+     * Constructor.
+     */
     VerticalLayout(const VerticalLayout& copy);
 };
 

gameplay/src/gameplay.h

@@ -7,7 +7,6 @@
 #include "Mouse.h"
 #include "FileSystem.h"
 #include "Package.h"
-#include "ScreenDisplayer.h"
 
 // Math
 #include "Rectangle.h"
@@ -45,6 +44,7 @@
 #include "FrameBuffer.h"
 #include "RenderTarget.h"
 #include "DepthStencilTarget.h"
+#include "ScreenDisplayer.h"
 
 // Audio
 #include "AudioController.h"