AudioProcessor trait: document the origin of the onmessage method

Author: orottier

src/context/base.rs

@@ -25,6 +25,8 @@ pub trait BaseAudioContext {
     /// Construct a new pair of [`AudioNode`] and [`AudioProcessor`]
     ///
     /// The `AudioNode` lives in the user-facing control thread. The Processor is sent to the render thread.
+    ///
+    /// Check the `examples/worklet.rs` file for example usage of this method.
     fn register<
         T: AudioNode,
         F: FnOnce(AudioContextRegistration) -> (T, Box<dyn AudioProcessor>),

src/render/processor.rs

@@ -105,6 +105,10 @@ pub trait AudioProcessor: Send {
     /// via
     /// [`AudioContextRegistration::post_message`](crate::context::AudioContextRegistration::post_message).
     /// This will not be necessary for most processors.
+    ///
+    /// This method is just a shim of the full
+    /// [`MessagePort`](https://webaudio.github.io/web-audio-api/#dom-audioworkletprocessor-port)
+    /// `onmessage` functionality of the AudioWorkletProcessor.
     #[allow(unused_variables)]
     fn onmessage(&mut self, msg: Box<dyn Any + Send + 'static>) {
         log::warn!("Ignoring incoming message");