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

Support all Swift 2 doc keywords #317

Closed
mkieselmann opened this issue Oct 9, 2015 · 2 comments
Closed

Support all Swift 2 doc keywords #317

mkieselmann opened this issue Oct 9, 2015 · 2 comments

Comments

@mkieselmann
Copy link

Hi,
is there any possibility to treat the throws keyword in Swift 2 as a special case for methods; just like returns or the parameters.
For example:

/**
Description

  - throws: Error
  - returns: the list of log files
*/
public static func getLogFiles() throws -> [String] 

The returns description is styled in a special way just as the parameters, which are formatted with a table. It would be great to have a special style for the throws keyworks that is applied automatically for any - throws: descriptiondeclarations.

Best regards and keep up the great work on jazzy.

@jpsim
Copy link
Collaborator

jpsim commented Oct 15, 2015

We should totally support this, along with all the other keywords described here: http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/

@jpsim jpsim changed the title Throws keyword is not detected Support all Swift 2 doc keywords Oct 19, 2015
jpsim added a commit that referenced this issue Oct 24, 2015
@jpsim
Copy link
Collaborator

jpsim commented Oct 24, 2015

@mkieselmann and @jessesquires, you may be interested in #323, which provides support for this.

@pigeon-archive pigeon-archive modified the milestone: The Past Nov 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants