在rust中,我想让rustdoc文本链接到一个枚举变量。这是什么语法?
示例
给定位于项目文件src/common.rs
中的rust code,(此rustdoc代码链接失败)
/// your result!
# [derive(Clone, Copy, Debug, PartialEq)]
pub enum MyResult<T, E> {
/// this is good!
Found(T),
/// task completed!
Done,
/// this is bad!
Err(E),
}
impl<T, E> MyResult<T, E> {
/// Returns `true` if the result is [`Found`], [`Done`].
///
/// In other words, this is not an [`Err`](Err)
///
/// [Found]: self::MyResult::Found
/// [Done]: self::Done
/// [Err]: crate::common::MyResult::Err
pub const fn is_ok(&self) -> bool {
matches!(*self, MyResult::Found(_) | MyResult::Done)
}
}
fn main() {}
rust文档是使用以下命令构建的:
cargo doc --locked --release --frozen --no-deps -v
问题
在生成的rust文档中,各种链接锚点无法链接到MyResult
内的枚举变体。
创建的文档如下所示:
Returns true if the result is [Found], [Done].
In other words, this is not an Err
- 文本
[Found]
和[Done]
无法链接。 - 文本
Err
链接到https://doc.rust-lang.org/beta/core/result/enum.Result.html#variant.Err
。 - 我还尝试了链接语法的其他变体,如
/// [Done]: MyResult#variant.Done
/// [Done]: self::MyResult#variant.Done
我如何创建rust doc到模块内enum
变体的文档内链接?
1条答案
按热度按时间szqfcxe21#
使用语法形式
问题的示例rustdoc代码将具有
#variant.
链接锚:在rustdoc输出中,单击文本
Found
,然后跳转到枚举变量Found
的定义。相关,链接方法类似,使用
#method.
链接锚: