Fix docstrings for CLAP message response structs

This commit is contained in:
Robbert van der Helm
2022-10-09 15:19:43 +02:00
parent 22cd6a0d58
commit 79c9a3f5f6
5 changed files with 20 additions and 12 deletions
@@ -118,7 +118,8 @@ struct Count {
}; };
/** /**
* The response to the `clap::ext::audio_ports::Get` message defined below. * The response to the `clap::ext::audio_ports::plugin::Get` message defined
* below.
*/ */
struct GetResponse { struct GetResponse {
std::optional<AudioPortInfo> result; std::optional<AudioPortInfo> result;
+6 -4
View File
@@ -133,7 +133,8 @@ struct SetScale {
}; };
/** /**
* The response to the `clap::ext::params::GetSize` message defined below. * The response to the `clap::ext::params::plugin::GetSize` message defined
* below.
*/ */
struct GetSizeResponse { struct GetSizeResponse {
bool result; bool result;
@@ -178,8 +179,8 @@ struct CanResize {
}; };
/** /**
* The response to the `clap::ext::params::GetResizeHints` message defined * The response to the `clap::ext::params::plugin::GetResizeHints` message
* below. * defined below.
*/ */
struct GetResizeHintsResponse { struct GetResizeHintsResponse {
// This doesn't require a special wrapper since the struct only contains // This doesn't require a special wrapper since the struct only contains
@@ -209,7 +210,8 @@ struct GetResizeHints {
}; };
/** /**
* The response to the `clap::ext::params::AdjustSize` message defined below. * The response to the `clap::ext::params::plugin::AdjustSize` message defined
* below.
*/ */
struct AdjustSizeResponse { struct AdjustSizeResponse {
bool result; bool result;
@@ -85,7 +85,8 @@ struct Count {
}; };
/** /**
* The response to the `clap::ext::note_ports::Get` message defined below. * The response to the `clap::ext::note_ports::plugin::Get` message defined
* below.
*/ */
struct GetResponse { struct GetResponse {
std::optional<NotePortInfo> result; std::optional<NotePortInfo> result;
+9 -5
View File
@@ -93,7 +93,8 @@ struct Count {
}; };
/** /**
* The response to the `clap::ext::params::GetInfo` message defined below. * The response to the `clap::ext::params::plugin::GetInfo` message defined
* below.
*/ */
struct GetInfoResponse { struct GetInfoResponse {
std::optional<ParamInfo> result; std::optional<ParamInfo> result;
@@ -122,7 +123,8 @@ struct GetInfo {
}; };
/** /**
* The response to the `clap::ext::params::GetValue` message defined below. * The response to the `clap::ext::params::plugin::GetValue` message defined
* below.
*/ */
struct GetValueResponse { struct GetValueResponse {
std::optional<double> result; std::optional<double> result;
@@ -151,7 +153,8 @@ struct GetValue {
}; };
/** /**
* The response to the `clap::ext::params::ValueToText` message defined below. * The response to the `clap::ext::params::plugin::ValueToText` message defined
* below.
*/ */
struct ValueToTextResponse { struct ValueToTextResponse {
std::optional<std::string> result; std::optional<std::string> result;
@@ -182,7 +185,8 @@ struct ValueToText {
}; };
/** /**
* The response to the `clap::ext::params::TextToValue` message defined below. * The response to the `clap::ext::params::plugin::TextToValue` message defined
* below.
*/ */
struct TextToValueResponse { struct TextToValueResponse {
std::optional<double> result; std::optional<double> result;
@@ -213,7 +217,7 @@ struct TextToValue {
}; };
/** /**
* The response to the `clap::ext::params::Flush` message defined below. * The response to the `clap::ext::params::plugin::Flush` message defined below.
*/ */
struct FlushResponse { struct FlushResponse {
clap::events::EventList out; clap::events::EventList out;
+1 -1
View File
@@ -30,7 +30,7 @@ namespace state {
namespace plugin { namespace plugin {
/** /**
* The response to the `clap::ext::state::Save` message defined below. * The response to the `clap::ext::state::plugin::Save` message defined below.
*/ */
struct SaveResponse { struct SaveResponse {
std::optional<clap::stream::Stream> result; std::optional<clap::stream::Stream> result;