alex/nih-plug
1
0
Fork 0
Code Activity

Silence missing docs warnings for entry points

Browse source
This commit is contained in:
Robbert van der Helm 2023-03-02 12:58:51 +01:00
parent b840113caf
commit 6fe5c7c471
2 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/wrapper/clap.rs
View file

@ -51,6 +51,7 @@ macro_rules! nih_export_clap {
} }
} }
/// The CLAP plugin's entry point.
#[no_mangle] #[no_mangle]
#[used] #[used]
pub static clap_entry: ::nih_plug::wrapper::clap::clap_plugin_entry = pub static clap_entry: ::nih_plug::wrapper::clap::clap_plugin_entry =

7
src/wrapper/vst3.rs
View file

@ -17,6 +17,7 @@ pub use factory::Factory;
#[macro_export] #[macro_export]
macro_rules! nih_export_vst3 { macro_rules! nih_export_vst3 {
($plugin_ty:ty) => { ($plugin_ty:ty) => {
/// The VST3 plugin factory entry point.
#[no_mangle] #[no_mangle]
pub extern "system" fn GetPluginFactory() -> *mut ::std::ffi::c_void { pub extern "system" fn GetPluginFactory() -> *mut ::std::ffi::c_void {
let factory = ::nih_plug::wrapper::vst3::Factory::<$plugin_ty>::new(); let factory = ::nih_plug::wrapper::vst3::Factory::<$plugin_ty>::new();
@ -27,6 +28,7 @@ macro_rules! nih_export_vst3 {
// These two entry points are used on Linux, and they would theoretically also be used on // These two entry points are used on Linux, and they would theoretically also be used on
// the BSDs: // the BSDs:
// https://github.com/steinbergmedia/vst3_public_sdk/blob/c3948deb407bdbff89de8fb6ab8500ea4df9d6d9/source/main/linuxmain.cpp#L47-L52 // https://github.com/steinbergmedia/vst3_public_sdk/blob/c3948deb407bdbff89de8fb6ab8500ea4df9d6d9/source/main/linuxmain.cpp#L47-L52
#[allow(missing_docs)]
#[no_mangle] #[no_mangle]
#[cfg(all(target_family = "unix", not(target_os = "macos")))] #[cfg(all(target_family = "unix", not(target_os = "macos")))]
pub extern "C" fn ModuleEntry(_lib_handle: *mut ::std::ffi::c_void) -> bool { pub extern "C" fn ModuleEntry(_lib_handle: *mut ::std::ffi::c_void) -> bool {
@ -34,6 +36,7 @@ macro_rules! nih_export_vst3 {
true true
} }
#[allow(missing_docs)]
#[no_mangle] #[no_mangle]
#[cfg(all(target_family = "unix", not(target_os = "macos")))] #[cfg(all(target_family = "unix", not(target_os = "macos")))]
pub extern "C" fn ModuleExit() -> bool { pub extern "C" fn ModuleExit() -> bool {
@ -42,6 +45,7 @@ macro_rules! nih_export_vst3 {
// These two entry points are used on macOS: // These two entry points are used on macOS:
// https://github.com/steinbergmedia/vst3_public_sdk/blob/bc459feee68803346737901471441fd4829ec3f9/source/main/macmain.cpp#L60-L61 // https://github.com/steinbergmedia/vst3_public_sdk/blob/bc459feee68803346737901471441fd4829ec3f9/source/main/macmain.cpp#L60-L61
#[allow(missing_docs)]
#[no_mangle] #[no_mangle]
#[cfg(target_os = "macos")] #[cfg(target_os = "macos")]
pub extern "C" fn bundleEntry(_lib_handle: *mut ::std::ffi::c_void) -> bool { pub extern "C" fn bundleEntry(_lib_handle: *mut ::std::ffi::c_void) -> bool {
@ -49,6 +53,7 @@ macro_rules! nih_export_vst3 {
true true
} }
#[allow(missing_docs)]
#[no_mangle] #[no_mangle]
#[cfg(target_os = "macos")] #[cfg(target_os = "macos")]
pub extern "C" fn bundleExit() -> bool { pub extern "C" fn bundleExit() -> bool {
@ -57,6 +62,7 @@ macro_rules! nih_export_vst3 {
// And these two entry points are used on Windows: // And these two entry points are used on Windows:
// https://github.com/steinbergmedia/vst3_public_sdk/blob/bc459feee68803346737901471441fd4829ec3f9/source/main/dllmain.cpp#L59-L60 // https://github.com/steinbergmedia/vst3_public_sdk/blob/bc459feee68803346737901471441fd4829ec3f9/source/main/dllmain.cpp#L59-L60
#[allow(missing_docs)]
#[no_mangle] #[no_mangle]
#[cfg(target_os = "windows")] #[cfg(target_os = "windows")]
pub extern "system" fn InitDll() -> bool { pub extern "system" fn InitDll() -> bool {
@ -64,6 +70,7 @@ macro_rules! nih_export_vst3 {
true true
} }
#[allow(missing_docs)]
#[no_mangle] #[no_mangle]
#[cfg(target_os = "windows")] #[cfg(target_os = "windows")]
pub extern "system" fn ExitDll() -> bool { pub extern "system" fn ExitDll() -> bool {