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

#36 in FFI

Download history 7743/week @ 2024-03-14 8716/week @ 2024-03-21 6028/week @ 2024-03-28 8483/week @ 2024-04-04 7875/week @ 2024-04-11 13813/week @ 2024-04-18 19454/week @ 2024-04-25 18095/week @ 2024-05-02 19880/week @ 2024-05-09 19330/week @ 2024-05-16 20088/week @ 2024-05-23 23557/week @ 2024-05-30 18918/week @ 2024-06-06 18542/week @ 2024-06-13 21666/week @ 2024-06-20 18019/week @ 2024-06-27

81,577 downloads per month
Used in 24 crates (5 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
~26K SLoC