jazzy v0.6.3 发布,一个生成 Swift 和 Objective-C文档的工具

jopen 5年前
   <p style="text-align: center;"><img alt="" src="https://simg.open-open.com/show/badefae165a83ec6425c51037f7a69a4.png" /></p>    <p>jazzy 是一个用于生成 Swift 和 Objective-C 文档的工具。它会读取您的源代码,然后使用分析器将您的注释提取出来,最后根据这些信息生成一个漂亮的 HTML 文档。您可以将您的文档和代码结合起来,这样就可以方便进行管理,尤其是当代码发生改变的时候。如果您引入了新的参数或者移除了现有的某个参数,那么在同一个地方您就可以对代码和文档同时进行管理。</p>    <h2>更新日志</h2>    <h3>功能增强</h3>    <ul>     <li> <p><code>--exclude</code> flag now supports excluding directories in addition to files. <a href="/misc/goto?guid=4958991310561026807">Gurrinder</a> <a href="/misc/goto?guid=4958991310662116120">#503</a></p> </li>     <li> <p>The <code>cocoapods</code> gem was updated to 1.0.1 and <code>rouge</code> to 1.11.0. <a href="/misc/goto?guid=4958991310751734810">Samuel Giddins</a> <a href="/misc/goto?guid=4958991310848045194">#568</a></p> </li>     <li> <p>Extra markdown documentation can now be included as their own pages in the sidebar using the <code>--documentation</code> option and in the generated Dash docset as Guides. <a href="/misc/goto?guid=4958991310940958242">Karl Bowden</a> <a href="/misc/goto?guid=4958991311033450662">#435</a></p> </li>     <li> <p>Section headings can now include additional markdown content using the <code>--abstract</code> option. <a href="/misc/goto?guid=4958991310940958242">Karl Bowden</a> <a href="/misc/goto?guid=4958991311033450662">#435</a></p> </li>     <li> <p>If Swift version is not specified, look for Swift toolchain or clang location<br /> in the following order:</p>      <ul>       <li><code>$XCODE_DEFAULT_TOOLCHAIN_OVERRIDE</code></li>       <li><code>$TOOLCHAIN_DIR</code></li>       <li><code>xcrun -find swift</code></li>       <li><code>/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain</code></li>       <li><code>/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain</code></li>       <li><code>~/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain</code></li>       <li><code>~/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain</code></li>      </ul> <p>This will be especially useful once jazzy supports generating docs for<br /> Swift Package Manager modules with a toolchain not tied to an Xcode release. <a href="/misc/goto?guid=4958978880901669116">JP Simard</a></p> </li>    </ul>    <p>Bug修复</p>    <ul>     <li>Don't document clang-unexposed Objective-C declarations <a href="/misc/goto?guid=4958978880901669116">JP Simard</a> <a href="/misc/goto?guid=4958991311191658494">#573</a></li>    </ul>    <h2>下载</h2>    <ul>     <li><a href="/misc/goto?guid=4958991311282485343" rel="nofollow"><strong>Source code</strong> (zip)</a></li>     <li><a href="/misc/goto?guid=4958991311379066344" rel="nofollow"><strong>Source code</strong> (tar.gz)</a></li>    </ul>