openframeworks / openFrameworks

openFrameworks is a community-developed cross platform toolkit for creative coding in C++.
http://openframeworks.cc
Other
9.97k stars 2.55k forks source link

documentation fixes: ofNode #4950

Open bakercp opened 8 years ago

bakercp commented 8 years ago

Hey all, a few of these got merged before I got to take a look at them.

    /// \brief Set local scale for xyz axes individually.
    /// \param param0 Desired local scale for x axis as a float where 1 = 100%.
    /// \param param1 Desired local scale for y axis as a float where 1 = 100%.
    /// \param param2 Desired local scale for z axis as a float where 1 = 100%.
    void setScale(float sx, float sy, float sz);

should be

    /// \brief Set local scale for xyz axes individually.
    /// \param sx Desired local scale for x axis as a float where 1 = 100%.
    /// \param sy Desired local scale for y axis as a float where 1 = 100%.
    /// \param xz Desired local scale for z axis as a float where 1 = 100%.
    void setScale(float sx, float sy, float sz);

Add a blank line after the brief and order should be:

e.g.

    /// \brief If you extend ofNode and wish to change the way it draws, extend this.
    /// \param param0 A pointer to the renderer you want to draw to.
    /// \note Try to not use global functions for rendering and instead use the passed
    /// renderer.
    virtual void customDraw(const ofBaseRenderer * renderer) const;

should be

    /// \brief If you extend ofNode and wish to change the way it draws, extend this.
        ///
    /// \note Try to not use global functions for rendering and instead use the passed
    /// renderer.
    /// \param param0 A pointer to the renderer you want to draw to.
    virtual void customDraw(const ofBaseRenderer * renderer) const;

thanks @digitalcoleman !

bakercp commented 8 years ago

Hey @digitalcoleman do you want to take this on? Otherwise, I'm happy to do it.

digitalcoleman commented 8 years ago

:( I dont have the time until March 12th to fix my mess. If it can wait I would like to clean up.

bakercp commented 8 years ago

It can wait as far as I know.

digitalcoleman commented 8 years ago

submitted my fixes.