[Asterisk-code-review] Add notes about embedded ast frame structs holding a format ... (asterisk[14])

[Richard Mudgett]

Richard Mudgett has uploaded a new change for review. ( https://gerrit.asterisk.org/4781 )

Change subject: Add notes about embedded ast_frame structs holding a format ref.
......................................................................

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
---
M include/asterisk/mod_format.h
M include/asterisk/translate.h
2 files changed, 6 insertions(+), 2 deletions(-)


  git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/81/4781/1

diff --git a/include/asterisk/mod_format.h b/include/asterisk/mod_format.h
index bcd31de..7e05a28 100644
--- a/include/asterisk/mod_format.h
+++ b/include/asterisk/mod_format.h
@@ -114,7 +114,11 @@
 	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 b8cd219..fe3b040 100644
--- a/include/asterisk/translate.h
+++ b/include/asterisk/translate.h
@@ -208,7 +208,7 @@
  */
 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;

-- 
To view, visit https://gerrit.asterisk.org/4781
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I86bda354d725207b41e08920355d7c31b2d7f749
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: 14
Gerrit-Owner: Richard Mudgett <rmudgett at digium.com>