doxygen-rs

将 Doxygen 转换为 Rustdoc。

文档在此处提供

安装

将此添加到您的 Cargo.toml

[dependencies]
doxygen-rs = "0.4"

与 Bindgen 一起使用

支持 >=0.63 bindgen

#[derive(Debug)]
struct Cb;

impl ParseCallbacks for Cb {
    fn process_comment(&self, comment: &str) -> Option<String> {
        Some(doxygen_rs::transform(comment))
    }
}

示例

use doxygen_rs::transform;

let rustdoc = transform("@brief Example Doxygen brief");
assert_eq!(rustdoc, "Example Doxygen brief\n\n");

lib.rs:

简单的 Doxygen 到 Rustdoc 转换。

提供简单直观的 API，将 原始 Doxygen 注释转换为 Rustdoc 注释。目前仅作为实验，未来可能实用？

示例

use doxygen_rs::transform;

let rustdoc = transform("@brief Example Doxygen brief");
assert_eq!(rustdoc, "Example Doxygen brief");

与 bindgen >= 0.63 一起使用

#[derive(Debug)]
struct Cb;

impl ParseCallbacks for Cb {
    fn process_comment(&self, comment: &str) -> Option<String> {
        Some(doxygen_rs::transform(comment))
    }
}