File: README.md

package info (click to toggle)
rust-doxygen-rs 0.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 160 kB
  • sloc: makefile: 4
file content (33 lines) | stat: -rw-r--r-- 644 bytes parent folder | download
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
# doxygen-rs
Transform Doxygen to Rustdoc.

[**Docs available here**](https://docs.rs/doxygen-rs/latest/doxygen_rs/)

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

## 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");
```