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.

Sign up for GitHub

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

Jump to bottom

Update to use updated documentation style. #7

Merged
merged 2 commits into from Jan 23, 2017
Merged

Update to use updated documentation style. #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9f05e6
Update to use updated documentation style.
cerihughes Jan 22, 2017
50855e3
Update after comments from @rastersize
cerihughes Jan 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Expand Up @@ -122,20 +122,20 @@ Comments
**Example:**
```objc
/*
* 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
* space.
*
* 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.

This is a new paragraph in the same block comment.
*/

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 Xcode’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 Xcode). The `///` form is preferred for single line
comments, and `/** */` for multi-line comments. Use the same formatting as in the example block above.

Pragma Marks
Expand Down