迅速な文書を生成するためにJazzyが期待どおりに機能していない

Question

迅速なコードを文書化するための最良の方法についていくつかの調査を行った後、私はJazzyにやって来て、それを実装するのがいかに簡単かを知りました。そこで私はJazzy Documentationのインストールセクションに従います。私はその後、私はターミナルでは、私のプロジェクトのルートに移動し、1クラスのドキュメントを表示するウェブサイトで、「ドキュメント」というフォルダを作成するjazzyを実行

sudo gem install jazzy 

を実行します。私は87のクラスを持っています。私は目に見えて、ターミナル出力でジャジーなループを見ることができます。

私はJazzy DocumentationとMarkup Formatting Referenceにリンクしている文書化コードについてのNSHipster Tutorialを読んでいます。 Xcodeがサイドペインに正しく表示するか、関数またはクラスを右クリックすると、いくつかのコードが文書化されました。だから私はかなり私の構文が正しいことを確認しています。

私はその1つのファイルを表示されていない別のファイルと比較するのに時間がかかっていましたが、フォーマットに関して普通のことは何も表示されません。

私が実行している：

• ジャジーバージョン：0.3.2
• Xcodeのバージョン：7.1
• スウィフトバージョン：2.1
• OS Xエルキャピタンバージョン：10.11

私の全体的な質問は次のとおりです。なぜすべてのクラスでジャジーなドキュメントを作成していないのですが、どうすればこの問題を解決できますか？

Answer 1

ジャズをもっと深く読んだ後、私はこの重要な情報を見つけました。

デフォルトでは、jazzyは公開宣言のみを文書化します。アクセシビリティレベルが （内部または非公開）の宣言に対して のドキュメントを生成するには、--min-aclフラグをinternalまたは privateに設定してください。私は私の前に、すべてをお読みください

jazzy --min-acl private 

注：jazzy git hub page

のトラブルシューティング部分で、私は私が予想ドキュメントを生成するために次の行でジャジー走っている

何かが正しく働いていないと決めました。

Answer 2

さらに改善してください。使用
jazzy --min-acl internal --skip-undocumented
説明：これはあなたのドキュメンタリーのすべてのfuntions、クラス、構造体が含まれます
--min-acl internal
それが文書化され68％のように述べた方法