openframeworks / openframeworks/openFrameworks

documentation fixes: ofNode

Open
#4,950 4 comments 0 reactions 1 assignee View on GitHub

@bakercp is already working on this.

Since Feb 25, 2016.

docsprint documentation
Dominant language
C++
Stars
10.4k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
9

Description

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

  • Parameter names need to match those in the function:
    /// \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:

  • brief
  • blank
  • description
  • notes, warnings, throws, etc
  • params
  • returns

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 !

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.