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

#44 in FFI

Download history 1324/week @ 2023-12-06 1368/week @ 2023-12-13 998/week @ 2023-12-20 1440/week @ 2023-12-27 1881/week @ 2024-01-03 1889/week @ 2024-01-10 3332/week @ 2024-01-17 5638/week @ 2024-01-24 4484/week @ 2024-01-31 5480/week @ 2024-02-07 5808/week @ 2024-02-14 6401/week @ 2024-02-21 5551/week @ 2024-02-28 6379/week @ 2024-03-06 7587/week @ 2024-03-13 6828/week @ 2024-03-20

27,265 downloads per month
Used in 18 crates (4 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.7–1.2MB
~25K SLoC