Skip to content

Update code documentation comments to the newer style #11

@OrkhanAlikhanov

Description

@OrkhanAlikhanov

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? {}

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions