Merge pull request #2745 from natecook1000/nc-doc-initreturns

[stdlib] Documentation consistency for OptionSet initializers

Author: amartini51

stdlib/public/core/OptionSet.swift

@@ -115,11 +115,10 @@ public protocol OptionSet : SetAlgebra, RawRepresentable {
   ///     print(extraOptions.isStrictSuperset(of: .all))
   ///     // Prints "true"
   ///
-  /// - Parameter rawValue: The raw value of the option set to create.
-  /// - Returns: A new option set with the given raw value. Each bit of the raw
-  ///   value potentially represents an element of the option set, though raw
-  ///   values may include bits that are not defined as distinct values of the
-  ///   `OptionSet` type.
+  /// - Parameter rawValue: The raw value of the option set to create. Each bit
+  ///   of `rawValue` potentially represents an element of the option set,
+  ///   though raw values may include bits that are not defined as distinct
+  ///   values of the `OptionSet` type.
   init(rawValue: RawValue)
 }
 
@@ -319,8 +318,6 @@ extension OptionSet where RawValue : BitwiseOperations {
   /// Creates an empty option set.
   ///
   /// This initializer creates an option set with a raw value of zero.
-  ///
-  /// - Returns: An option set that contains no elements.
   public init() {
     self.init(rawValue: .allZeros)
   }

test/SourceKit/DocSupport/doc_clang_module.swift.response

@@ -5580,7 +5580,7 @@ var FooSubUnnamedEnumeratorA1: Int { get }
         key.name: "init()",
         key.usr: "s:FesRxs9OptionSetwx8RawValues17BitwiseOperationsrS_cFT_x::SYNTHESIZED::c:@E@FooRuncingOptions",
         key.original_usr: "s:FesRxs9OptionSetwx8RawValues17BitwiseOperationsrS_cFT_x",
-        key.doc.full_as_xml: "<Function><Name>init()</Name><USR>s:FesRxs9OptionSetwx8RawValues17BitwiseOperationsrS_cFT_x</USR><Declaration>convenience init()</Declaration><Abstract><Para>Creates an empty option set.</Para></Abstract><ResultDiscussion><Para>An option set that contains no elements.</Para></ResultDiscussion><Discussion><Para>This initializer creates an option set with a raw value of zero.</Para></Discussion></Function>",
+        key.doc.full_as_xml: "<Function><Name>init()</Name><USR>s:FesRxs9OptionSetwx8RawValues17BitwiseOperationsrS_cFT_x</USR><Declaration>convenience init()</Declaration><Abstract><Para>Creates an empty option set.</Para></Abstract><Discussion><Para>This initializer creates an option set with a raw value of zero.</Para></Discussion></Function>",
         key.offset: 1933,
         key.length: 18,
         key.fully_annotated_decl: "<decl.function.constructor><syntaxtype.keyword>convenience</syntaxtype.keyword> <syntaxtype.keyword>init</syntaxtype.keyword>()</decl.function.constructor>"