有没有办法从文档中隐藏Rust宏模式?

从Rust 1.6.0 ,宏中的模式有隐藏的实现。

有没有办法隐藏Cargo-generated文档中的一些模式? 还是我离开提取他们分开的宏,并添加#[doc(hidden)]给那些?

macro_rules! mc {
    /// hide this
    ( ... ) => ( ... );
}

由于没有其他答案,我想这是最佳解决方案:

/// Not meant to be called directly
#[doc(hidden)]
#[macro_export]
macro_rules! hidden {
    ( $hidden_rule1:expr ) => { ... };
    ( $hidden_rule2:expr ) => { ... };
    ...
}

#[macro_export]
macro_rules! public {
    ( $public:expr ) => ( hidden!($public) );
}

您正在使用一个单独的hidden宏(可能需要公开),但它不是文档的一部分。 所有应该隐藏的规则都将被隐藏,并且public宏将在作为文档一部分的public宏中可见。

链接地址: http://www.djcxy.com/p/32165.html

上一篇: Is there a way to hide a Rust macro pattern from docs?

下一篇: recursive if scalar, array