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

Update code documentation comments to the newer style #11

Closed
OrkhanAlikhanov opened this issue Sep 7, 2018 · 1 comment
Closed

Update code documentation comments to the newer style #11

OrkhanAlikhanov opened this issue Sep 7, 2018 · 1 comment

Comments

@OrkhanAlikhanov
Copy link

This style comments:

 /**
  :name: removeValueForKey
  :description: Removes a single instance of a value for a key. This is
  important when using non-unique keys.
  - returns: Value?
 */
public func removeInstanceValueForKey(_ key: Key) -> Value? {}

Should be updated to the newer style:

 /**
  Removes a single instance of a value for a key. This is
  important when using non-unique keys.
  - Parameter _ key: A Key.
  - Returns: Removed Value for given key, nil on fail.
 */
public func removeInstanceValueForKey(_ key: Key) -> Value? {}
@daniel-jonathan
Copy link
Member

This is a great issue to open. We can do it together.

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

No branches or pull requests

2 participants