averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update standard library doc comments to Markdown

Browse Source 
rdar://problem/20180478

Swift SVN r27726
This commit is contained in:
David Farler
2015-04-26 00:07:11 +00:00
parent 6c8e9ac276
commit 9e28dc777a
83 changed files with 1395 additions and 1459 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
stdlib/public/core/SequenceAlgorithms.swift.gyb
View File

@@ -24,15 +24,15 @@ GElement = "Generator.Element"
extension SequenceType {
/// Return a lazy `SequenceType` containing pairs (*n*, *x*), where
/// *n*\ s are consecutive `Int`\ s starting at zero, and *x*\ s are
/// the elements of `base`::
/// *n*s are consecutive `Int`s starting at zero, and *x*s are
/// the elements of `base`:
///
/// > for (n, c) in enumerate("Swift") { println("\(n): '\(c)'" ) }
/// 0: 'S'
/// 1: 'w'
/// 2: 'i'
/// 3: 'f'
/// 4: 't'
/// > for (n, c) in enumerate("Swift") { println("\(n): '\(c)'" ) }
/// 0: 'S'
/// 1: 'w'
/// 2: 'i'
/// 3: 'f'
/// 4: 't'
final public func _prext_enumerate() -> EnumerateSequence<Self> {
return EnumerateSequence(self)
}
@@ -49,8 +49,7 @@ extension SequenceType {
%{
if preds:
orderingRequirement = """
/// Requires: `isOrderedBefore` is a `strict weak ordering
/// <http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings>`__
/// Requires: `isOrderedBefore` is a [strict weak ordering](http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings).
/// over `self`."""
else:
orderingRequirement = ""
@@ -60,7 +59,7 @@ extension SequenceType ${"" if preds else "where Self.Generator.Element : Compar
/// Returns the minimum element in `self`.
///
/// Complexity: O(count(elements))
/// - complexity: O(count(elements))
/// ${orderingRequirement}
final public func _prext_minElement(
% if preds:
@@ -81,7 +80,7 @@ extension SequenceType ${"" if preds else "where Self.Generator.Element : Compar
/// Returns the maximum element in `self`.
///
/// Complexity: O(count(elements))
/// - complexity: O(count(elements))
/// ${orderingRequirement}
final public func _prext_maxElement(
% if preds:
@@ -119,8 +118,7 @@ if preds:
/// Return true iff `self` begins with elements equivalent to those of
/// `other`, using `isEquivalent` as the equivalence test.
///
/// Requires: `isEquivalent` is an `equivalence relation
/// <http://en.wikipedia.org/wiki/Equivalence_relation>`_"""
/// Requires: `isEquivalent` is an [equivalence relation](http://en.wikipedia.org/wiki/Equivalence_relation)"""
else:
comment = """
/// Return true iff the the initial elements of `s` are equal to `prefix`."""
@@ -167,8 +165,7 @@ if preds:
/// Return true iff `self` and `other` contain equivalent elements, using
/// `isEquivalent` as the equivalence test.
///
/// Requires: `isEquivalent` is an `equivalence relation
/// <http://en.wikipedia.org/wiki/Equivalence_relation>`_"""
/// Requires: `isEquivalent` is an [equivalence relation](http://en.wikipedia.org/wiki/Equivalence_relation)"""
else:
comment = """
/// Return `true` iff `self` and `other` contain the same elements in the
@@ -224,8 +221,7 @@ if preds:
/// Return true iff `self` precedes `other` in a lexicographical ("dictionary")
/// ordering, using `isOrderedBefore` as the comparison between elements.
///
/// Requires: isOrderedBefore` is a `strict weak ordering
/// <http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings>`__
/// Requires: `isOrderedBefore` is a [strict weak ordering](http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings)
/// over the elements of `self` and `other`."""
else:
comment = """
@@ -435,7 +431,7 @@ extension SequenceType {
extension SequenceType {
/// Returns a sequence of pairs built out of two underlying sequences,
/// where the elements of the `i`\ th pair are the `i`\ th elements
/// where the elements of the `i`th pair are the `i`th elements
/// of each underlying sequence.
final public func _prext_zip<OtherSequence : SequenceType>(
other: OtherSequence