Skip to content

Commit 0be3642

Browse files
committed
improve example of comment documentation
1 parent 34f5db9 commit 0be3642

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

bk1ch08p350documentation/bk1ch08p350documentation/ViewController.swift

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,15 @@ class ViewController: UIViewController {
99

1010
* Because it's cool.
1111
* Because it's there.
12-
13-
#### Parameters
14-
15-
`cats` A string containing cats
16-
17-
#### Return Value
18-
19-
A string containing dogs
12+
13+
- parameters:
14+
15+
- cats: A string containing cats
16+
17+
- returns: A string containing dogs
18+
19+
- author: Who do you think?
20+
2021
*/
2122

2223
func dogMyCats(cats:String) -> String {
@@ -32,6 +33,18 @@ class ViewController: UIViewController {
3233
override func viewDidLoad() {
3334
super.viewDidLoad()
3435
}
36+
37+
/*
38+
39+
For spec, see https://developer.apple.com/library/mac/documentation/Xcode/Reference/xcode_markup_formatting_ref/index.html
40+
41+
Other type 1 markers are: throws,
42+
43+
Other type 2 (description subgraf) markers are: Precondition, Postcondition, Requires, Invariant, Complexity, Important, Warning, Author, Authors, Copyright, Date, SeeAlso, Since, Version, Attention, Bug, Experiment, Note, Remark, ToDo
44+
45+
Release notes also mention keyword, recommended, recommendedover, but I don't see them doing anything.
46+
47+
*/
3548

3649

3750
}

0 commit comments

Comments
 (0)