jazzy v0.6.3 發布,一個生成 Swift 和 Objective-C文檔的工具

jopen 8年前發布 | 11K 次閱讀 jazzy Swift Objective-C

jazzy 是一個用于生成 Swift 和 Objective-C 文檔的工具。它會讀取您的源代碼,然后使用分析器將您的注釋提取出來,最后根據這些信息生成一個漂亮的 HTML 文檔。您可以將您的文檔和代碼結合起來,這樣就可以方便進行管理,尤其是當代碼發生改變的時候。如果您引入了新的參數或者移除了現有的某個參數,那么在同一個地方您就可以對代碼和文檔同時進行管理。

更新日志

功能增強

  • --exclude flag now supports excluding directories in addition to files. Gurrinder #503

  • The cocoapods gem was updated to 1.0.1 and rouge to 1.11.0. Samuel Giddins #568

  • Extra markdown documentation can now be included as their own pages in the sidebar using the --documentation option and in the generated Dash docset as Guides. Karl Bowden #435

  • Section headings can now include additional markdown content using the --abstract option. Karl Bowden #435

  • If Swift version is not specified, look for Swift toolchain or clang location
    in the following order:

    • $XCODE_DEFAULT_TOOLCHAIN_OVERRIDE
    • $TOOLCHAIN_DIR
    • xcrun -find swift
    • /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
    • /Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
    • ~/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
    • ~/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain

    This will be especially useful once jazzy supports generating docs for
    Swift Package Manager modules with a toolchain not tied to an Xcode release. JP Simard

    </li> </ul>

    Bug修復

    • Don't document clang-unexposed Objective-C declarations JP Simard #573

    下載

     本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
     轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
     本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!