Update to use updated documentation style. #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rastersize
suggested changes
Jan 22, 2017
| */ | ||
|
|
||
| stop(); // Hammer-time! | ||
|
|
||
| // this is a very brief comment. | ||
| ``` | ||
|
|
||
| * Use [doxygen](http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html)-style comments for all the headers. Make | ||
| sure to use the available markup tags like `@param`, `@return`, etc. The `///` form is preferred for single line | ||
| * Document all methods and properties in the headers using Xcode8's documentation style. You can select a property |
There was a problem hiding this comment.
Xcode8's 👉 Xcode 8’s
I.e. space between Xcode and 8 and typographic apostrophe.
There was a problem hiding this comment.
Haha. You and your apostrophes! :) Will fix!
| sure to use the available markup tags like `@param`, `@return`, etc. The `///` form is preferred for single line | ||
| * Document all methods and properties in the headers using Xcode8's documentation style. You can select a property | ||
| or method and use `Cmd`-`/` to see this in action. Make sure to use the available markup tags like `@param`, | ||
| `@return`, etc. (these will be auto-generated for you by Xcode8). The `///` form is preferred for single line |
There was a problem hiding this comment.
How about omitting the Xcode version number here. Since it was made clear in the sentences just before. Also gets old in just a few months :)
| * | ||
| * This is a new paragraph in the same block comment. | ||
| This is a multi-line comment. The opening and closing markers are on their | ||
| own lines, and each other line is preceded by a * that is indented by one |
There was a problem hiding this comment.
Remove “, and each other line is preceded by a * that is indented by one space.” Since its no longer true
There was a problem hiding this comment.
Ooops. Well spotted.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use this form:
instead of this: