doxygen-rs 0.2.2

Transform Doxygen to Rustdoc
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# doxygen-rs

Transform Doxygen to Rustdoc.

[**Docs available here**](https://techie-pi.github.io/doxygen-rs/doxygen_rs/) _Though somewhat outdated ;p_

## Installation

Add this to your ``Cargo.toml``
```toml
[dependencies]
doxygen-rs = "0.2"
```

## Usage with Bindgen

> Available on >=0.63 bindgen

```rs
#[derive(Debug)]

struct Cb;

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

## Example

```rust
use doxygen_rs::transform;

let rustdoc = transform("@brief Example Doxygen brief");
assert_eq!(rustdoc, "Example Doxygen brief\n\n");
```

## Architecture

Check [architecture.md](docs/architecture.md)