Move keyword comments to docstrings

Author: msanders

swift-mode-font-lock.el

@@ -57,16 +57,15 @@ Return nil otherwise."
 ;; Keywords
 ;; https://developer.apple.com/library/ios/documentation/Swift/Conceptual/Swift_Programming_Language/LexicalStructure.html#//apple_ref/doc/uid/TP40014097-CH30-ID410
 
-;; Member functions in the standard library in Swift 3 which may be used
-;; with trailing closures and no parentheses.
 (defconst swift-mode:member-functions-trailing-closure
  '("sort" "sorted" "split" "contains" "index" "partition" "filter" "first"
  "forEach" "flatMap" "withMutableCharacters" "withCString"
  "withUnsafeMutableBufferPointer" "withUnsafeMutablePointers"
  "withUnsafeMutablePointerToElements" "withUnsafeMutablePointerToHeader"
- "withUnsafeBufferPointer" "withUTF8Buffer" "min" "map" "max"))
+ "withUnsafeBufferPointer" "withUTF8Buffer" "min" "map" "max")
+ "Member functions in the standard library in Swift 3 which may be used
+ with trailing closures and no parentheses.")
 
-;; Member functions in the standard library in Swift 3.
 (defconst swift-mode:member-functions
  '("symmetricDifference" "storeBytes" "starts" "stride" "sortInPlace"
  "successor" "suffix" "subtract" "subtracting" "subtractInPlace"
@@ -108,14 +107,14 @@ Return nil otherwise."
  "moveInitializeBackwardFrom" "moveInitializeFrom" "moveAssign"
  "moveAssignFrom" "multiply" "multiplyWithOverflow" "multiplied" "measure"
  "makeIterator" "makeDescription" "maximum" "maximumMagnitude" "maxElement"
- "bindMemory"))
+ "bindMemory")
+ "Member functions in the standard library in Swift 3.")
 
-;; Global functions available in Swift 3 which may be used with trailing
-;; closures and no parentheses.
 (defconst swift-mode:global-functions-trailing-closure
- '("anyGenerator" "autoreleasepool"))
+ '("anyGenerator" "autoreleasepool")
+ "Global functions available in Swift 3 which may be used with trailing
+ closures and no parentheses.")
 
-;; Global functions available in Swift 3.
 (defconst swift-mode:global-functions
  '("stride" "strideof" "strideofValue" "sizeof" "sizeofValue" "sequence" "swap"
  "numericCast" "transcode" "isUniquelyReferenced"
@@ -124,13 +123,13 @@ Return nil otherwise."
  "unsafeAddressOf" "print" "precondition" "preconditionFailure" "fatalError"
  "withUnsafeMutablePointer" "withUnsafePointer" "withExtendedLifetime"
  "withVaList" "assert" "assertionFailure" "alignof" "alignofValue" "abs"
- "repeatElement" "readLine" "getVaList" "min" "max"))
+ "repeatElement" "readLine" "getVaList" "min" "max")
+ "Global functions available in Swift 3.")
 
-;; Properties in the standard library in Swift 3.
 (defconst swift-mode:process-properties
- '("arguments" "argc" "unsafeArgv"))
+ '("arguments" "argc" "unsafeArgv")
+ "Properties in the standard library in Swift 3.")
 
-;; Properties in the standard library in Swift 3.
 (defconst swift-mode:properties
  '("startIndex" "stringValue" "stride" "size" "sign" "signBitIndex"
  "significand" "significandBitCount" "significandBitPattern"
@@ -151,10 +150,9 @@ Return nil otherwise."
  "leastNormalMagnitude" "last" "lazy" "alignment" "allocatedElementCount"
  "allZeros" "array" "arrayPropertyIsNativeTypeChecked" "radix" "rawValue"
  "greatestFiniteMagnitude" "min" "memory" "max" "byteSize" "byteSwapped"
- "binade" "bitPattern" "bigEndian" "buffer" "base" "baseAddress"))
+ "binade" "bitPattern" "bigEndian" "buffer" "base" "baseAddress")
+ "Properties in the standard library in Swift 3.")
 
-;; Enum cases in the standard library - note that there is some overlap between
-;; these and the properties
 (defconst swift-mode:enum-cases
  '("scalarValue" "size" "signalingNaN" "sound" "some" "suppressed" "sprite"
  "set" "none" "negativeSubnormal" "negativeNormal" "negativeInfinity"
@@ -164,18 +162,19 @@ Return nil otherwise."
  "positiveSubnormal" "positiveNormal" "positiveInfinity" "positiveZero"
  "point" "plus" "error" "emptyInput" "view" "quietNaN" "float"
  "attributedString" "awayFromZero" "rectangle" "range" "generated" "minus"
- "bool" "bezierPath"))
+ "bool" "bezierPath")
+ "Enum cases in the standard library - note that there is some overlap
+between these and the properties")
 
-;; Enum types in the standard library in Swift 3.
 (defconst swift-mode:enum-types
  '("ImplicitlyUnwrappedOptional" "Representation" "MemoryLayout"
  "FloatingPointClassification" "SetIndexRepresentation"
  "SetIteratorRepresentation" "FloatingPointRoundingRule"
  "UnicodeDecodingResult" "Optional" "DictionaryIndexRepresentation"
  "AncestorRepresentation" "DisplayStyle" "PlaygroundQuickLook" "Never"
- "FloatingPointSign" "Bit" "DictionaryIteratorRepresentation"))
+ "FloatingPointSign" "Bit" "DictionaryIteratorRepresentation")
+ "Enum types in the standard library in Swift 3.")
 
-;; Protocols in the standard library in Swift 3.
 (defconst swift-mode:protocols
  '("RandomAccessCollection" "RandomAccessIndexable"
  "RangeReplaceableCollection" "RangeReplaceableIndexable" "RawRepresentable"
@@ -194,9 +193,9 @@ Return nil otherwise."
  "ExpressibleByExtendedGraphemeClusterLiteral" "ExpressibleByFloatLiteral"
  "ExpressibleByArrayLiteral" "FloatingPoint" "LosslessStringConvertible"
  "LazySequenceProtocol" "LazyCollectionProtocol" "AnyObject"
- "AbsoluteValuable"))
+ "AbsoluteValuable")
+ "Protocols in the standard library in Swift 3.")
 
-;; Structs in the standard library in Swift 2 only.
 (defconst swift-mode:structs
  '("Repeat" "Repeated" "ReversedRandomAccessCollection"
  "ReversedRandomAccessIndex" "ReversedCollection" "ReversedIndex"
@@ -237,9 +236,9 @@ Return nil otherwise."
  "LazyFilterCollection" "LazyFilterIndex" "LazyFilterIterator"
  "AnyRandomAccessCollection" "AnyGenerator" "AnyBidirectionalCollection"
  "AnySequence" "AnyHashable" "AnyCollection" "AnyIndex" "AnyIterator"
- "AutoreleasingUnsafeMutablePointer" "Array" "ArraySlice"))
+ "AutoreleasingUnsafeMutablePointer" "Array" "ArraySlice")
+ "Structs in the standard library in Swift 3.")
 
-;; Typealiases in the standard library in Swift 3.
 (defconst swift-mode:typealiases
  '("RawSignificand" "RawExponent" "RawValue" "BooleanLiteralType" "Buffer"
  "Base" "Storage" "StringLiteralType" "Stride" "Stream1" "Stream2"
@@ -252,17 +251,18 @@ Return nil otherwise."
  "UnicodeScalarLiteralType" "UnfoldFirstSequence" "UTF16Index" "UTF16View"
  "UTF8Index" "UIntMax" "Element" "Elements" "ExtendedGraphemeClusterType"
  "ExtendedGraphemeClusterLiteralType" "Exponent" "Void" "Value" "Key"
- "Float32" "FloatLiteralType" "Float64" "AnyClass" "Any"))
+ "Float32" "FloatLiteralType" "Float64" "AnyClass" "Any")
+ "Typealiases in the standard library in Swift 3.")
 
-;; Built-in class types.
 (defconst swift-mode:class-types
- '("ManagedBuffer" "ManagedProtoBuffer" "NonObjectiveCBase" "AnyGenerator"))
+ '("ManagedBuffer" "ManagedProtoBuffer" "NonObjectiveCBase" "AnyGenerator")
+ "Built-in class types.")
 
-;; Precedence groups in the standard library.
 (defconst swift-mode:precedence-groups
  '("BitwiseShift" "Assignment" "RangeFormation" "Casting" "Addition"
  "NilCoalescing" "Comparison" "LogicalConjunction" "LogicalDisjunction"
- "Default" "Ternary" "Multiplication" "FunctionArrow"))
+ "Default" "Ternary" "Multiplication" "FunctionArrow")
+ "Precedence groups in the standard library.")
 
 (defconst swift-mode:constant-keywords
  '(
@@ -271,43 +271,43 @@ Return nil otherwise."
  "CommandLine" "Process"
  ;; The return type of a function that never returns.
  "Never")
- )
+ "Keywords used as constants.")
 
-;; Keywords that begin with a number sign (#).
 (defconst swift-mode:preprocessor-keywords
  '("#available" "#colorLiteral" "#column" "#else" "#elseif" "#endif"
  "#fileLiteral" "#file" "#function" "#if" "#imageLiteral" "#keypath" "#line"
- "#selector" "#sourceLocation"))
+ "#selector" "#sourceLocation")
+ "Keywords that begin with a number sign (#).")
 
-;; Keywords used in declarations.
 (defconst swift-mode:declaration-keywords
  '("associatedtype" "class" "deinit" "enum" "extension" "fileprivate" "func"
  "import" "init" "inout" "internal" "let" "open" "operator" "private"
- "protocol" "public" "static" "struct" "subscript" "typealias" "var"))
+ "protocol" "public" "static" "struct" "subscript" "typealias" "var")
+ "Keywords used in declarations.")
 
-;; Keywords used in statements.
 (defconst swift-mode:statement-keywords
  '("break" "case" "continue" "default" "defer" "do" "else" "fallthrough" "for"
- "guard" "if" "in" "repeat" "return" "switch" "where" "while"))
+ "guard" "if" "in" "repeat" "return" "switch" "where" "while")
+ "Keywords used in statements.")
 
-;; Keywords used in expressions and types (without true, false, and keywords
-;; begin with a number sign)
 (defconst swift-mode:expression-keywords
  '("as" "catch" "dynamicType" "is" "rethrows" "super" "self" "Self" "throws"
- "throw" "try"))
+ "throw" "try")
+ "Keywords used in expressions and types (without true, false, and
+ keywords begin with a number sign)")
 
-;; Keywords reserved in particular contexts.
 (defconst swift-mode:context-keywords
  '("Protocol" "Type" "and" "assignment" "associativity" "convenience" "didSet"
  "dynamic" "final" "get" "higherThan" "indirect" "infix" "lazy" "left"
  "lowerThan" "mutating" "none" "nonmutating" "optional" "override" "postfix"
  "precedence" "precedencegroup" "prefix" "required" "right" "set" "unowned"
- "weak" "willSet"))
+ "weak" "willSet")
+ "Keywords reserved in particular contexts.")
 
-;; Keywords for build configuration statements.
 (defconst swift-mode:build-config-keywords
  '("os" "arch" "swift" "OSX" "iOS" "watchOS" "tvOS" "i386" "x86_64" "arm"
- "arm64" "iOSApplicationExtension" "OSXApplicationExtension"))
+ "arm64" "iOSApplicationExtension" "OSXApplicationExtension")
+ "Keywords for build configuration statements.")
 
 (defconst swift-mode:font-lock-keywords
  `(