Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update document to latest format #3621

Merged
merged 10 commits into from
Nov 7, 2018
Merged

Commits on Sep 22, 2018

  1. Add Parameters Section

    ```
    (\n[ ]+)(((/// - parameter \w+:.*\s+)(///((\s+)|( \s+.+\s+)))?)*/// - parameter \w+:.*)
    ```
    
    ```
    $1/// - Parameters:$1$2
    ```
    kemchenj committed Sep 22, 2018
    Configuration menu
    Copy the full SHA
    08820aa View commit details
    Browse the repository at this point in the history
  2. Remove parameter prefix

    ```
    /// - parameter (\w+):(.*)(\s+///(\n))*(\s+)
    ```
    
    ```
    ///   - $1:$2$4$5
    ```
    kemchenj committed Sep 22, 2018
    Configuration menu
    Copy the full SHA
    576d7af View commit details
    Browse the repository at this point in the history
  3. Remove property’s returns section

    ```
    /// - returns: (.+\s+((override|@IBOutlet|@objc|weak|unowned|lazy|static|class|open|public|private|fileprivate|internal)(\(set\))? )*(var|let))
    ```
    
    ```
    /// $1
    ```
    kemchenj committed Sep 22, 2018
    Configuration menu
    Copy the full SHA
    849acbe View commit details
    Browse the repository at this point in the history
  4. Add missing -

    ```
    /// (note|return|parameters|throws):
    ```
    
    ```
    /// - $1:
    ```
    kemchenj committed Sep 22, 2018
    Configuration menu
    Copy the full SHA
    bad3eef View commit details
    Browse the repository at this point in the history

Commits on Sep 23, 2018

  1. Sort sections

    ```
    ((///)[ ]+[^-\n]+(\s+))?(((((/// - Parameters:\s+(/// (( - \w+:)|([^-]{1})).*\s+)+)\s+)|(/// - Returns:.*\s+(/// [^-]{1}.*\s+)*)|(/// - Note:.*\s+(/// [^-]{1}.*\s+)*)|(/// - Throws:.*\s+(/// [^-]{1}.*\s+)*))(///\n\s+)?)+)
    ```
    
    ```
    $1$2$3$15$7$17$13
    ```
    kemchenj committed Sep 23, 2018
    Configuration menu
    Copy the full SHA
    f3fa752 View commit details
    Browse the repository at this point in the history
  2. Uppercased the section title

    kemchenj committed Sep 23, 2018
    Configuration menu
    Copy the full SHA
    0edceea View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    c68ed07 View commit details
    Browse the repository at this point in the history
  4. Remove duplicated section

    kemchenj committed Sep 23, 2018
    Configuration menu
    Copy the full SHA
    033bb11 View commit details
    Browse the repository at this point in the history

Commits on Oct 21, 2018

  1. Configuration menu
    Copy the full SHA
    a4cae71 View commit details
    Browse the repository at this point in the history

Commits on Oct 28, 2018

  1. Remove meaningless comment

    kemchenj committed Oct 28, 2018
    Configuration menu
    Copy the full SHA
    a435669 View commit details
    Browse the repository at this point in the history