SwiftMarkupGen

SwiftMarkupGen is a swift package to generate swift documentation markup template given a function signature. It uses sourcekitd.framework to parse the function signature.

This is useful to write plugins for text editors.

Requirements:

• Latest Swift 3 snapshot from https://swift.org/download/#snapshots
• Currently SourceKit only works on OSX so Linux is not supported for now.

Installation:

$ make install

Usage:

$ MarkupGen-bin "public func hello(cool a: Int, abc b: FooType) throws -> FooType {"
/// hello(cool:abc:)
///
/// - Parameters:
///     - cool:
///     - abc:
///
/// - Throws:
///
/// - Returns:

Build:

$ make
or
$ swift build -Xlinker -undefined -Xlinker dynamic_lookup

License

MIT