Add notes about embedded ast_frame structs holding a format ref.

mod_format.h: Note ast_filestream.fr holds a format ref.

translate.h: Note ast_trans_pvt.f holds a format ref.

Change-Id: I86bda354d725207b41e08920355d7c31b2d7f749

diff --git a/include/asterisk/mod_format.h b/include/asterisk/mod_format.h
index 7f17741fa16bcd27391f0fbeaa3729ebe167deaf..d76be5eca2b8d6ec706aea09f9668c2c7cece76e 100644 (file)
--- a/include/asterisk/mod_format.h
+++ b/include/asterisk/mod_format.h
@@ -114,7 +114,11 @@ struct ast_filestream {
        int lasttimeout;
        struct ast_channel *owner;
        FILE *f;
-       struct ast_frame fr;    /*!< frame produced by read, typically */
+       /*!
+        * \brief frame produced by read, typically
+        * \note This frame holds a fr.subclass.format ref.
+        */
+       struct ast_frame fr;
        char *buf;              /*!< buffer pointed to by ast_frame; */
        void *_private; /*!< pointer to private buffer */
        const char *orig_chan_name;

diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h
index e2a4f300fb55405fbeef7c1085b774f43453ba08..ce46cd083a4db48faf4868fe48b366f7b11c9205 100644 (file)
--- a/include/asterisk/translate.h
+++ b/include/asterisk/translate.h
@@ -208,7 +208,7 @@ struct ast_translator {
  */
 struct ast_trans_pvt {
        struct ast_translator *t;
-       struct ast_frame f;         /*!< used in frameout */
+       struct ast_frame f;         /*!< used in frameout.  This frame holds a f.subclass.format ref. */
        int samples;                /*!< samples available in outbuf */
        /*! \brief actual space used in outbuf */
        int datalen;