openframeworks / openframeworks/openFrameworks

documentation fixes: ofFileUtils.h

Open
#4,951 8 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 low level doc PRs got merged before I got to take a look at them -- for ofFileUtils.h a couple things --

To conform to doxygen style guide (https://github.com/openframeworks/openFrameworks/wiki/openFrameworks-doxygen-documentation-style-guidelines)

  • Mixed use of \return \returns - both are valid, but style guide suggests \returns
  • Need complete sentences with capitalization / punctuation, it's -> its where appropriate.
  • 80 char hard breaks unless impossible.
  • Need \brief line with a blank line after (for parsers -- \brief tag will be removed later) and order should
    be:
    • brief
    • blank
    • description
    • notes, warnings, throws, etc
    • params
    • returns

I'm happy to take a pass unless someone else wants to.

Thanks @danomatika for all of your work on these!

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.