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

#43 in FFI

Download history 13363/week @ 2024-11-15 15619/week @ 2024-11-22 18821/week @ 2024-11-29 21248/week @ 2024-12-06 19673/week @ 2024-12-13 6861/week @ 2024-12-20 6364/week @ 2024-12-27 18909/week @ 2025-01-03 20216/week @ 2025-01-10 20433/week @ 2025-01-17 20070/week @ 2025-01-24 22735/week @ 2025-01-31 27857/week @ 2025-02-07 20757/week @ 2025-02-14 21020/week @ 2025-02-21 17884/week @ 2025-02-28

91,458 downloads per month
Used in 52 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