Crate doxygen_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\n\n");

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))
    }
}

Supported commands

See the tracking issue for the exhaustive list

Modules

ast

This module contains functions that generate ASTs from Vec of crate::parser::Value

generator

Generate raw Rustdoc comments from a given crate::ast::ParsedDoxygen

parser

This module contains functions to generate a Vec of Value from a given input

Functions

transform

Transforms raw Doxygen comments to raw Rustdoc comments

transform_bindgen