Helgobox runtime API mechanism: Support doc

api/src/runtime/mod.rs

@@ -4,7 +4,7 @@ use std::ffi::{c_char, c_long, c_void, CStr};
 use std::mem::transmute;
 
 macro_rules! api {
-    ($( $func_name:ident ($( $param_name:ident: $param_type:ty ),*) -> $ret_type:ty, )+) => {
+    ($( $( #[doc = $doc:expr] )* $func_name:ident ($( $param_name:ident: $param_type:ty ),*) -> $ret_type:ty, )+) => {
         pub struct HelgoboxApiPointers {
             $(
                 $func_name: Option<fn($( $param_name: $param_type ),*) -> $ret_type>
@@ -37,6 +37,7 @@ macro_rules! api {
             }
 
             $(
+                $( #[doc = $doc] )*
                 pub fn $func_name(&self, $( $param_name: $param_type ),*) -> $ret_type {
                     self.pointers.$func_name.unwrap()($( $param_name ),*)
                 }
@@ -63,6 +64,17 @@ macro_rules! api {
 }
 
 api![
+    /// Finds the first Helgobox instance in the given project.
+    ///
+    /// If the given project is `null`, it will look in the current project.
+    ///
+    /// Returns the instance ID or -1 if none exists.
     HB_FindFirstInstanceInProject(project: *const ReaProject) -> c_long,
+
+
+    /// Shows or hides the app for the given Helgobox instance and makes sure that the app displays
+    /// Playtime.
+    ///
+    /// If necessary, this will also start the app and create a clip matrix for the given instance.
     HB_ShowOrHidePlaytime(instance_id: c_long) -> (),
 ];

main/src/infrastructure/plugin/api_impl.rs

@@ -26,14 +26,3 @@ pub fn register_api() {
         ));
     });
 }
-
-// Finds the first Helgobox instance in the given project.
-//
-// If the given project is `null`, it will look in the current project.
-//
-// Returns the instance ID or -1 if none exists.
-
-// Shows or hides the app for the given Helgobox instance and makes sure that the app displays
-// Playtime.
-//
-// If necessary, this will also start the app and create a clip matrix for the given instance.