---

Ⅰ. 插件描述

Swift Documentation Markup Template Generator

Ⅱ. 基本信息

创建日期：  2016-06-07 使用用户：  1 Github星：  38 插件作者：  Ankit Aggarwal

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'aciidb0mb3r/swiftmarkupgen'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'aciidb0mb3r/swiftmarkupgen'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'aciidb0mb3r/swiftmarkupgen'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/aciidb0mb3r/swiftmarkupgen

Ⅳ. 文档说明

# 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