19

現在、Rust と Cargo を使用したプロジェクトに取り組んでいます。うまく機能しますが、ちょっとした問題が発生します。コードを再利用するために、私のプロジェクトのほとんどは lib クレートの中にあります。このクレートでは、多くのことがプライベートです。だから私がそうするときcargo doc、私は公開され、エクスポートされたもののドキュメントを持っているだけです...これは実際に素晴らしいです.何がエクスポートされ、何がエクスポートされていないかを簡単に確認できるからです.

しかし、私は認めなければなりません: 開発目的のため、プロジェクト全体の完全なドキュメントを見逃しています...

4

4 に答える 4

20

さび 1.41

バイナリのドキュメントには、デフォルトでバイナリ クレートのプライベート アイテムが含まれます。

さび 1.29

使えるようになりましたcargo doc --document-private-items

以前のバージョン

現在、Cargo では実行できない可能性があります。rustdoc を直接使用する場合の回避策があります。

実行cargo doc -vするrustdocコマンドを実行してメモします。

$ cargo doc -v
   Compiling docz v0.0.1 (file:///private/tmp/docz)
     Running `rustdoc src/lib.rs -o /private/tmp/docz/target/doc --crate-name docz -L dependency=/private/tmp/docz/target/debug -L dependency=/private/tmp/docz/target/debug/deps`

--no-defaults --passes strip-hidden --passes collapse-docs --passes unindent-comments次に、コマンドに次を追加します。

rustdoc src/lib.rs -o /private/tmp/docz/target/doc --crate-name docz \
    -L dependency=/private/tmp/docz/target/debug \
    -L dependency=/private/tmp/docz/target/debug/deps \
    --no-defaults \
    --passes strip-hidden --passes collapse-docs --passes unindent-comments
于 2015-03-31T23:48:00.797 に答える
8

これは、rustdoc の後に引数を渡すことで実行できます--。

cargo rustdoc -- \
    --no-defaults \
    --passes strip-hidden \
    --passes collapse-docs \
    --passes unindent-comments \
    --passes strip-priv-imports

@Shepmaster の回答に基づいて、手動でコピーして貼り付ける必要はありません。

于 2016-09-07T15:56:55.407 に答える
8

これはより簡単になりました。次を使用してください。

cargo rustdoc -- --document-private-items
于 2018-03-09T21:58:30.570 に答える