-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Comments
@danomatika Do you want to take this on? Otherwise, I'm happy to do it. |
What about \brief after \class? Whitespace there too? |
Yes, whitespace there too. |
So much for "minimal, 1 or 2 lines" :) |
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 ... |
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". :) |
Closed with #4979 |
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)
be:
I'm happy to take a pass unless someone else wants to.
Thanks @danomatika for all of your work on these!
The text was updated successfully, but these errors were encountered: