Update callback contexts docs

membraneframework · Jan 10, 2023 · b8ee62d · b8ee62d
1 parent fe194f0
commit b8ee62d
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 2 deletions.
diff --git a/lib/membrane/bin/callback_context.ex b/lib/membrane/bin/callback_context.ex
@@ -1,8 +1,14 @@
 defmodule Membrane.Bin.CallbackContext do
   @moduledoc """
-  Module describiing context passed to the `Membrane.Bin` callbacks.
+  Module describing context passed to the `Membrane.Bin` callbacks.
   """
 
+  @typedoc """
+  Type describing context passed to the `Membrane.Bin` callbacks.
+
+  Field `:pad_options` is present only in `c:Membrane.Bin.handle_pad_added/3`
+  and `c:Membrane.Bin.handle_pad_removed/3`.
+  """
   @type t :: %{
           :clock => Membrane.Clock.t(),
           :parent_clock => Membrane.Clock.t(),

diff --git a/lib/membrane/element/callback_context.ex b/lib/membrane/element/callback_context.ex
@@ -1,8 +1,20 @@
 defmodule Membrane.Element.CallbackContext do
   @moduledoc """
-  Describes context passed to Membrane Elements callbacks.
+  Describes context passed to the Membrane Element callbacks.
   """
 
+  @typedoc """
+  Type describing context passed to the Membrane Element callbacks.
+
+  Field `:incoming_demand` is present only in
+  `c:Membrane.Element.WithOutputPads.handle_demand/5`.
+
+  Field `:pad_options` is present only in `c:Membrane.Element.Base.handle_pad_added/3`
+  and `c:Membrane.Element.Base.handle_pad_removed/3`.
+
+  Field `:old_stream_format` is present only in
+  `c:Membrane.Element.WithInputPads.handle_stream_format/5`.
+  """
   @type t :: %{
           :pads => %{Membrane.Pad.ref_t() => Membrane.Element.PadData.t()},
           :clock => Membrane.Clock.t() | nil,

diff --git a/lib/membrane/pipeline/callback_context.ex b/lib/membrane/pipeline/callback_context.ex
@@ -3,6 +3,14 @@ defmodule Membrane.Pipeline.CallbackContext do
   Module describing context passed to the `Membrane.Pipeline` callbacks.
   """
 
+  @typedoc """
+  Type describing context passed to the `Membrane.Pipeline` callbacks.
+
+  Field `:from` is present only in `c:Membrane.Pipeline.handle_call/3`.
+
+  Fields `:members` and `:crash_initiator` are present only in
+  `c:Membrane.Pipeline.handle_crash_group_down/3`.
+  """
   @type t :: %{
           :clock => Membrane.Clock.t(),
           :children => %{Membrane.Child.name_t() => Membrane.ChildEntry.t()},