summaryrefslogtreecommitdiff
path: root/src/ipa/libipa/fc_queue.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/ipa/libipa/fc_queue.cpp')
-rw-r--r--src/ipa/libipa/fc_queue.cpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/ipa/libipa/fc_queue.cpp b/src/ipa/libipa/fc_queue.cpp
index 0365e919..41c563dd 100644
--- a/src/ipa/libipa/fc_queue.cpp
+++ b/src/ipa/libipa/fc_queue.cpp
@@ -39,6 +39,16 @@ namespace ipa {
*/
/**
+ * \fn FrameContext::init()
+ * \param[in] frameNum The frame number to assign to this FrameContext
+ * \brief Initialize a frame context
+ *
+ * This function initializes a frame context by assigning it a frame number.
+ * The single IPA modules are expected to override this function to initialize
+ * their derived FrameContext implementation to their desired default values.
+ */
+
+/**
* \class FCQueue
* \brief A support class for managing FrameContext instances in IPA modules
* \tparam FrameContext The IPA module-specific FrameContext derived class type