6 releases

0.4.2 May 30, 2023
0.4.1 May 21, 2023
0.4.0 Apr 4, 2023
0.3.1 Feb 28, 2023
0.2.2 Jan 5, 2023

#100 in FFI

Download history 20410/week @ 2024-11-30 20857/week @ 2024-12-07 18181/week @ 2024-12-14 5299/week @ 2024-12-21 7786/week @ 2024-12-28 20676/week @ 2025-01-04 20689/week @ 2025-01-11 19664/week @ 2025-01-18 20802/week @ 2025-01-25 23454/week @ 2025-02-01 27867/week @ 2025-02-08 18761/week @ 2025-02-15 21111/week @ 2025-02-22 21811/week @ 2025-03-01 23458/week @ 2025-03-08 20757/week @ 2025-03-15

90,259 downloads per month
Used in 53 crates (10 directly)

BSD-3-Clause

51KB
1.5K SLoC

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

#[derive(Debug)]
struct Cb;

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

Dependencies

~0.6–1.1MB
~23K SLoC