Swift Documentation Markup Template Generator
Swift Makefile
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Sources
Tests/MarkupGen
.gitignore
.travis.yml
Makefile
Package.swift
README.md

README.md

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.

Build Status

Requirements:

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