doxygen-rs

Crates.iodoxygen-rs
lib.rsdoxygen-rs
version0.4.2
sourcesrc
created_at2023-01-05 21:54:00.241665
updated_at2023-05-30 16:22:37.701945
descriptionTransform Doxygen to Rustdoc
homepagehttps://github.com/Techie-Pi/doxygen-rs/
repositoryhttps://github.com/Techie-Pi/doxygen-rs/
max_upload_size
id751842
size55,935
TechiePi (Techie-Pi)

documentation

README

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");
Commit count: 103

cargo fmt