Added more info to parameter documentation syntax (#14)

* Added more info to parameter documentation syntax * Remove trailing whitespace

Author: drumnkyle

README.md

@@ -961,7 +961,22 @@ Guidelines:
 
 * **4.1.3** Do not prefix each additional line with a `*`.
 
-* **4.1.4** Use the new `- parameter` syntax as opposed to the old `:param:` syntax (make sure to use lower case `parameter` and not `Parameter`). See [the documentation on Swift Markup](https://developer.apple.com/library/watchos/documentation/Xcode/Reference/xcode_markup_formatting_ref/) for more details on how this is formatted.
+* **4.1.4** Use the new `- parameter` syntax as opposed to the old `:param:` syntax (make sure to use lower case `parameter` and not `Parameter`). Option-click on a method you wrote to make sure the quick help looks correct. See [the documentation on Swift Markup](https://developer.apple.com/library/watchos/documentation/Xcode/Reference/xcode_markup_formatting_ref/) for more details on how this is formatted.
+
+```swift
+class Human {
+ /**
+ This method feeds a certain food to a person.
+
+ - parameter food: The food you want to be eaten.
+ - parameter person: The person who should eat the food.
+ - returns: True if the food was eaten by the person; false otherwise.
+ */
+ func feed(_ food: Food, to person: Human) -> Bool {
+ // ...
+ }
+}
+```
 
 * **4.1.5** If you’re going to be documenting the parameters/returns/throws of a method, document all of them, even if some of the documentation ends up being somewhat repetitive (this is preferable to having the documentation look incomplete). Sometimes, if only a single parameter warrants documentation, it might be better to just mention it in the description instead.