Use consistent syntax for referencing functions
Since this is used in some places but not all, we should probably use
backticks here. Or better yet, use proper links for doxygen or sphinx.
///
/// Therefore the host should give a context hint for the operation it executes.
///
-/// Scenarios for save() function:
+/// Scenarios for the state save() function:
///
/// - Context `CLAP_STATE_CONTEXT_PROJECT`: The plugin stores all aound settings including
/// the project specific settings (like the hardware's id)
/// a new instance of the plugin to be presented as 'duplicate' effectively, like
/// using the next index of an enumeration, a channel etc.
///
-/// Scenarios for the load() function:
+/// Scenarios for the state load() function:
///
/// - Context `CLAP_STATE_CONTEXT_PROJECT`: The plugin restores all aound settings including
/// the project specific settings (like the hardware's id). If no project specific settings
@@ -67,12 +67,14 @@ enum clap_plugin_state_context_type {
};
typedef struct clap_plugin_state_context {
- // Hosts that use the set_state_context() function should *always* call it directly before
- // ->save() or load(). Plugins that implement the set() function should
- // keep the last assigned context around, regardless of the frequency of invocations.
+ // Hosts that use the set_state_context() function should *always* call it
+ // directly before clap_plugin_state->save() or clap_plugin_state->load().
+ // Plugins that implement the clap_plugin_state_context->set() function
+ // should keep the last assigned context around, regardless of the frequency
+ // of invocations.
- // Assign the context for subsequent calls to ->save() or load() of the
- // clap_plugin_state extension.
+ // Assign the context for subsequent calls to clap_plugin_state->save() or
+ // clap_plugin_state->load() of the clap_plugin_state extension.
// [main-thread]
void (*set)(const clap_plugin_t *plugin, uint32_t context);
} clap_plugin_state_context_t;
