Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation fixes: ofFileUtils.h #4951

Open
bakercp opened this issue Feb 25, 2016 · 8 comments
Open

documentation fixes: ofFileUtils.h #4951

bakercp opened this issue Feb 25, 2016 · 8 comments
Assignees
Milestone

Comments

@bakercp
Copy link
Member

bakercp commented Feb 25, 2016

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!

@bakercp bakercp self-assigned this Feb 25, 2016
@bakercp bakercp added this to the 0.10.0 milestone Feb 25, 2016
@bakercp
Copy link
Member Author

bakercp commented Feb 29, 2016

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

@danomatika
Copy link
Contributor

What about \brief after \class? Whitespace there too?

@bakercp
Copy link
Member Author

bakercp commented Feb 29, 2016

Yes, whitespace there too.

@danomatika
Copy link
Contributor

So much for "minimal, 1 or 2 lines" :)

@bakercp
Copy link
Member Author

bakercp commented Feb 29, 2016

Yes :), with that said, after a discussion w/ @workergnome and @HalfdanJ earlier today, we're planning to get rid of the \class tag, but I'd say for now leave it in and we'll remove it all at once when we run through a conformance check (@HalfdanJ is researching the possibility of a documentation linter). Fun times are ahead ...

@danomatika
Copy link
Contributor

I hope y'all aren't trying to outsmart doxygen too much ... sounds like heading down the road of "let's write our own documentation parser because the existing one isn't super pretty". :)

@danomatika
Copy link
Contributor

danomatika@64301c3

@danomatika
Copy link
Contributor

Closed with #4979

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants