From 8ecf73a086b41a33058211f7a415b771bb04f79d Mon Sep 17 00:00:00 2001 From: Paul Brewczynski Date: Wed, 13 Jan 2016 10:01:46 +0100 Subject: Updated documentation syntax As Xcode switched to Markdown syntax, I've updated it. --- swift.html.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'swift.html.markdown') diff --git a/swift.html.markdown b/swift.html.markdown index e6bf1621..c54f8e00 100644 --- a/swift.html.markdown +++ b/swift.html.markdown @@ -221,9 +221,9 @@ A greet operation - A bullet in docs - Another bullet in the docs -:param: name A name -:param: day A day -:returns: A string containing the name and day value. +- Parameter name : A name +- Parameter day : A day +- Returns : A string containing the name and day value. */ func greet(name: String, day: String) -> String { return "Hello \(name), today is \(day)." -- cgit v1.2.3 From 1c1944acb480d9c463c59136eba5ffa19f376fdc Mon Sep 17 00:00:00 2001 From: Paul Brewczynski Date: Thu, 14 Jan 2016 19:11:45 +0100 Subject: Updated comment on documentation of Swift functions Documentation syntax is no longer reStructuredText, It's "Swift-flavored version of Markdown" http://nshipster.com/swift-documentation/ --- swift.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'swift.html.markdown') diff --git a/swift.html.markdown b/swift.html.markdown index c54f8e00..46996526 100644 --- a/swift.html.markdown +++ b/swift.html.markdown @@ -213,7 +213,7 @@ default: // required (in order to cover all possible input) // Functions are a first-class type, meaning they can be nested // in functions and can be passed around -// Function with Swift header docs (format as reStructedText) +// Function with Swift header docs (format as Swift-modified Markdown syntax) /** A greet operation -- cgit v1.2.3 From 107356e627716b75cd79486dbacb1b5d119b4d82 Mon Sep 17 00:00:00 2001 From: Paul Brewczynski Date: Sat, 16 Jan 2016 19:30:25 +0100 Subject: [Swift/en] Deleted semicolon to be consistent - Small Fix this line let weak = "keyword"; let override = "another keyword" // statements can be separated by a semi-colon show off semicolon use. But after that semicolon is not used, so I removed inconsistency. --- swift.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'swift.html.markdown') diff --git a/swift.html.markdown b/swift.html.markdown index 46996526..46768375 100644 --- a/swift.html.markdown +++ b/swift.html.markdown @@ -392,7 +392,7 @@ testTryStuff() public class Shape { public func getArea() -> Int { - return 0; + return 0 } } -- cgit v1.2.3