Cosmetics

Author: kunitoki

modules/yup_gui/artboard/yup_Artboard.h

@@ -23,55 +23,140 @@ namespace yup
 {
 
 //==============================================================================
+/** Represents a Rive artboard.
+
+    This class is used to display a Rive artboard.
+*/
 class YUP_API Artboard : public Component
 {
 public:
     //==============================================================================
-    Artboard (StringRef componentID);
+    /** Creates a new Rive artboard.
+
+        @param componentID The ID of the component.
+    */
+    Artboard (StringRef componentID = {});
+
+    /** Creates a new Rive artboard.
+
+        @param componentID The ID of the component.
+        @param artboardFile The Rive artboard file to display.
+    */
     Artboard (StringRef componentID, std::shared_ptr<ArtboardFile> artboardFile);
 
+    //==============================================================================
+    /** Sets the Rive artboard file to display.
+
+        @param artboardFile The Rive artboard file to display.
+    */
     void setFile (std::shared_ptr<ArtboardFile> artboardFile);
 
     //==============================================================================
+    /** Clears the Rive artboard. */
     void clear();
 
     //==============================================================================
+    /** Returns true if the Rive artboard is paused. */
     bool isPaused() const;
+
+    /** Sets the Rive artboard to paused or running.
+
+        @param shouldPause True to pause the Rive artboard, false to run it.
+    */
     void setPaused (bool shouldPause);
 
+    /** Advances the Rive artboard by a given number of seconds.
+
+        @param elapsedSeconds The number of seconds to advance the Rive artboard by.
+    */
     void advanceAndApply (float elapsedSeconds);
+
+    /** Returns the duration of the Rive artboard in seconds. */
     float durationSeconds() const;
 
     //==============================================================================
+    /** Returns true if the Rive artboard has a boolean input with the given name. */
     bool hasBoolInput (const String& name) const;
+
+    /** Sets the value of a boolean input with the given name.
+
+        @param name The name of the input.
+        @param value The value to set the input to.
+    */
     void setBoolInput (const String& name, bool value);
 
+    /** Returns true if the Rive artboard has a number input with the given name. */
     bool hasNumberInput (const String& name) const;
+
+    /** Sets the value of a number input with the given name.
+
+        @param name The name of the input.
+        @param value The value to set the input to.
+    */
     void setNumberInput (const String& name, double value);
 
+    /** Returns true if the Rive artboard has a trigger input with the given name. */
     bool hasTriggerInput (const String& name) const;
+
+    /** Triggers a trigger input with the given name.
+
+        @param name The name of the input.
+    */
     void triggerInput (const String& name);
 
     //==============================================================================
+    /** Returns all the inputs of the Rive artboard. */
     var getAllInputs() const;
+
+    /** Sets all the inputs of the Rive artboard.
+
+        @param value The value to set the inputs to.
+    */
     void setAllInputs (const var& value);
+
+    /** Sets the value of an input with the given name.
+
+        @param name The name of the input.
+        @param value The value to set the input to.
+    */
     void setInput (const String& state, const var& value);
 
     //==============================================================================
+    /** A callback that is called when a property of the Rive artboard changes. */
     std::function<void (Artboard&, const String&, const String&, const var&, const var&)> onPropertyChanged;
 
-    virtual void propertyChanged (const String& eventName, const String& propertyName, const var& oldValue, const var& newValue);
+    /** A callback that is called when a property of the Rive artboard changes.
+
+        @param eventName The name of the event.
+        @param propertyName The name of the property.
+        @param oldValue The old value of the property.
+        @param newValue The new value of the property.
+    */
+    virtual void propertyChanged (const String& eventName,
+                                  const String& propertyName,
+                                  const var& oldValue,
+                                  const var& newValue);
 
     //==============================================================================
+    /** @internal */
     void refreshDisplay (double lastFrameTimeSeconds) override;
+    /** @internal */
     void paint (Graphics& g) override;
+    /** @internal */
     void resized() override;
+    /** @internal */
     void contentScaleChanged (float dpiScale) override;
+    /** @internal */
     void mouseEnter (const MouseEvent& event) override;
+    /** @internal */
     void mouseExit (const MouseEvent& event) override;
+    /** @internal */
     void mouseDown (const MouseEvent& event) override;
+    /** @internal */
     void mouseUp (const MouseEvent& event) override;
+    /** @internal */
     void mouseMove (const MouseEvent& event) override;
+    /** @internal */
     void mouseDrag (const MouseEvent& event) override;
 
 private:

modules/yup_gui/artboard/yup_ArtboardFile.h

@@ -25,19 +25,42 @@ namespace yup
 class Artboard;
 
 //==============================================================================
-class JUCE_API ArtboardFile
+/** Represents a Rive file.
+
+    This class is used to load Rive binary files (aka .riv files).
+*/
+class YUP_API ArtboardFile
 {
 public:
     //==============================================================================
-    const rive::File* getRiveFile() const;
-    rive::File* getRiveFile();
-
-    //==============================================================================
+    /** The result of loading a Rive file. */
     using LoadResult = ResultValue<std::shared_ptr<ArtboardFile>>;
 
+    /** Loads a Rive file from a file.
+
+        @param file The file to load.
+        @param factory The factory to use to create the Rive file.
+
+        @return The result of loading the Rive file.
+    */
     static LoadResult load (const File& file, rive::Factory& factory);
+
+    /** Loads a Rive file from an input stream.
+
+        @param is The input stream to load the Rive file from.
+        @param factory The factory to use to create the Rive file.
+
+        @return The result of loading the Rive file.
+    */
     static LoadResult load (InputStream& is, rive::Factory& factory);
 
+    //==============================================================================
+    /** Returns the underlying Rive file. */
+    const rive::File* getRiveFile() const;
+
+    /** Returns the underlying Rive file. */
+    rive::File* getRiveFile();
+
 private:
     ArtboardFile() = default;
     ArtboardFile (std::unique_ptr<rive::File> rivFile);