Xcode - Add Custom Documentation for Swift Closure

Question

Question:

What is the correct format to add documentation (using built in functionality not 3rd party) to a custom Swift closure in Xcode 8 ?
Could you provide the Apple documentation link to refer ?
How to specify the closure parameters ?
How to specify the closure return type ?

Example:

struct S1 {

    /// This block is executed after completion
    var completion : (String, Int) -> (Bool)
}

Note:

Xcode 8 has built in functionality to add documentation to custom code.

This can be done, by doing one of the following:

Command + Option + Click on code
Keep cursor on code and Editor > Structure > Add documentation

Community · Accepted Answer · 2020-06-20 09:12:55Z

1

Reference:

For reference see Markup Formatting Reference namely the section "Formatting Quick Help"

Workaround:

If those tags are not supported for the given location the only possible workaround seems to be right now:

struct S1 {
    
    /// description
    ///
    /// __returns__
    /// blah blah
    ///
    /// __parameters__
    /// blah blah
    var completion : (String, Int) -> (Bool)
}

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Aug 31, 2017 at 11:54

DrSvanHay

1,1926 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

user1046037 Over a year ago

The parameter and return type are not showing up. Only the description shows up for Swift Code.

DrSvanHay Over a year ago

ahh ok, now I understand the question! Added a paragraph to my answer. Sadly thats not going to change with Xcode9.

Collectives™ on Stack Overflow

Xcode - Add Custom Documentation for Swift Closure

Question:

Note:

1 Answer 1

Reference:

Workaround:

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Question:

Note:

1 Answer 1

Reference:

Workaround:

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related