我试图只为我的面向公众的API生成rustdoc. 我希望这包括pub个而不是pub(crate)个项目.

有没有一种方法可以在不单独排除每一项的情况下指明这一点?

pub struct DocumentMe;

// I do not want to have to
// explicitly specify excluding this
#[doc(hidden)]
pub(crate) struct DoNotDocumentMe;

正如@Chayim Friedman在 comments 中所写的那样,这只是二进制箱子的问题,而不是库箱子的问题.

推荐答案

从Rust 1.41开始,默认情况下会记录二进制机箱中的私有API.由于API不会导出给任何人(因为这是一个二进制),Rust假设您想要为源代码的使用者记录API,所以它还记录了私有项目.

在图书馆的箱子中,您可以更改默认设置,也可以使用--document-private-items标志记录私有物品.遗憾的是,我不认为有一个选项可以不记录二进制 crate 的私有物品.In the PR that changed the default for Rust 1.41, it was said that the PR can go without a flag to change the default and that such flag can be added in the future if there is a demand for it.我想这件事从来没有发生过.

Rust相关问答推荐

为什么我们不能通过指针算法将Rust原始指针指向任意地址?'

重新导出proc宏导致未解决的extern crate错误""

在没有引用计数或互斥锁的情况下,可以从Rust回调函数内的封闭作用域访问变量吗?

交换引用时的生命周期

如何为 struct 字段设置新值并在Ruust中的可变方法中返回旧值

我如何制作一个变异迭代器来锁定内部数据直到删除?

有没有可能让泛型Rust T总是堆分配的?

Cargo.toml:如何有条件地启用依赖项功能?

Rust Axum 框架 - 解包安全吗?

Rust 并行获取对 ndarray 的每个元素的可变引用

如何在 Rust 的 Hyper 异步闭包中从外部范围正确读取字符串值

在线程中运行时,TCPListener(服务器)在 ip 列表中的服务器实例之前没有从客户端接受所有客户端的请求

Rust Serde 为 Option:: 创建反序列化器

在 Rust 中,Weak 如何知道内部值何时被删除?

在 Rust 中,为什么整数溢出有时会导致编译错误或运行时错误?

将 Futures 的生命周期特征绑定到 fn 参数

判断对象是 PyDatetime 还是 Pydate 的实例?

`use std::error::Error` 声明中断编译

您不能borrow 对只读值的可变引用

函数参数的 Rust 功能标志