Jazzy沒有像預期的那樣生成快速文檔

Question

在對文檔swift代碼的最佳方式進行了一些研究之後。我遇到了Jazzy，實現起來多麼簡單。所以我按照Jazzy Documentation的安裝部分。我跑

sudo gem install jazzy 

然後我瀏覽到我的項目的根，在終端，並運行jazzy它創建了一個名爲「文檔」有一個網站，1類顯示文檔的文件夾。我有87個班級，可以在終端輸出中看到爵士樂循環播放。

我已閱讀NSHipster Tutorial有關記錄代碼的信息，這些代碼也將您鏈接到Jazzy Documentation以及Markup Formatting Reference。我記錄了一些代碼，Xcode在側窗格中正確顯示或右鍵單擊函數或類。所以我相當肯定我的語法是正確的。

我花了一些時間將這1個文件與另一個沒有被顯示的文件進行比較，並且我沒有發現與格式有關的任何內容。

我運行：

• 爵士版本：0.3.2
• 的Xcode版本：7.1
• 斯威夫特版本：2.1
• OS X埃爾卡皮坦版本：10.11

我的整體問題是;爲什麼不是爲所有課程生成文檔，我該如何解決這個問題？

Answer 1

在閱讀了更多有關爵士音樂深度的書後，我發現了這條重要的信息。

默認情況下，爵士只會記錄公共聲明。要爲具有較低可訪問性級別 （內部或私有）的聲明生成 文檔，請將--min-acl標誌設置爲internal或 private。

這是在拍攝的jazzy git hub page

部分我跑了爵士與下面的行產生的文檔我預期的麻煩：

jazzy --min-acl private 

注意我之前我應該​​看什麼決定一些工作不正確。

Answer 2

爲了讓它更好。使用
jazzy --min-acl internal --skip-undocumented
說明：
--min-acl internal這將包括所有funtions，類，結構在紀錄片
--skip-undocumented這會忽略所有的無證類...