doxygen-rs

Transform Doxygen to Rustdoc.

Docs available here

Installation

Add this to your Cargo.toml

[dependencies]
doxygen-rs = "0.4"

Usage with Bindgen

Available on >=0.63 bindgen

#[derive(Debug)]
struct Cb;

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

Example

use doxygen_rs::transform;

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

lib.rs:

Simple Doxygen to Rustdoc translation.

Provides a simple and straightforward API to translate raw Doxygen comments to Rustdoc comments. Purely experimental right now, maybe practical in a future?

Examples

use doxygen_rs::transform;

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

Usage with bindgen >= 0.63

# trait ParseCallbacks {
#   fn process_comment(&self, comment: &str) -> Option<String>;
# }
#[derive(Debug)]
struct Cb;

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