Skip to content

Conversation

nlutsenko
Copy link
Contributor

This change is required to power our new api ref generation.

  • Replaced /*! with /**
  • Removed @abstract, @discussion and converted @returns into @return
  • Updated all cross references from <[Class method]> to Class.+method style
  • Cleaned up and fixed few missing/wrong pieces of documentation.

The new style is as follows:

/**
 Short description of what the method does.

 Very long description that precisely describes on what we are doing with a cross reference link to `AnotherClass.+someRandomMethod`.

 @warning Some warning. // (optional)
 @note Some extra note. // (optional)

 @param argument This is a description of what is expected of this argument.

 @return Description of return value.
*/
- (BOOL)methodNameWithArgument:(id)argument;

@facebook-github-bot
Copy link

@nlutsenko updated the pull request.

@richardjrossiii
Copy link
Contributor

veryseriouscodereview.gif

nlutsenko added a commit that referenced this pull request Dec 2, 2015
Update all of the public documentation to new style.
@nlutsenko nlutsenko merged commit 0b0248c into master Dec 2, 2015
@nlutsenko nlutsenko deleted the nlutsenko.docs branch December 2, 2015 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants