From 47058869f0030310c70031573f5a50809c717f3d Mon Sep 17 00:00:00 2001
From: pv42 <pv42@gmail.com>
Date: Wed, 7 Aug 2024 14:22:49 +0200
Subject: [PATCH] Feat: add doc to public functions in mavlink-bindgen's lib.rs
---
mavlink-bindgen/src/lib.rs | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/mavlink-bindgen/src/lib.rs b/mavlink-bindgen/src/lib.rs
index 3448fe8..22f1efa 100644
--- a/mavlink-bindgen/src/lib.rs
+++ b/mavlink-bindgen/src/lib.rs
@@ -23,6 +23,9 @@ pub struct GeneratedBindings {
pub mod_rs: PathBuf,
}
+/// Generate Rust MAVLink dialect binding for dialects present in `definitions_dir` into `destination_dir`.
+///
+/// If successful returns paths of generated bindings linked to their dialect definitions files.
pub fn generate<P1: AsRef<Path>, P2: AsRef<Path>>(
definitions_dir: P1,
destination_dir: P2,
@@ -99,6 +102,7 @@ fn _generate(
}
}
+/// Formats generated code using `rustfmt`.
pub fn format_generated_code(result: &GeneratedBindings) {
if let Err(error) = Command::new("rustfmt")
.args(
@@ -114,6 +118,7 @@ pub fn format_generated_code(result: &GeneratedBindings) {
}
}
+/// Prints definitions for cargo that describe which files the generated code depends on, indicating when it has to be regenerated.
pub fn emit_cargo_build_messages(result: &GeneratedBindings) {
for binding in &result.bindings {
// Re-run build if definition file changes
--
GitLab