[svn-commits] dlee: branch dlee/record r390883 - /team/dlee/record/include/asterisk/

[SVN commits to the Digium repositories]

Author: dlee
Date: Fri Jun  7 13:33:58 2013
New Revision: 390883

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=390883
Log:
Doc cleanup

Modified:
    team/dlee/record/include/asterisk/stasis_app_recording.h

Modified: team/dlee/record/include/asterisk/stasis_app_recording.h
URL: http://svnview.digium.com/svn/asterisk/team/dlee/record/include/asterisk/stasis_app_recording.h?view=diff&rev=390883&r1=390882&r2=390883
==============================================================================
--- team/dlee/record/include/asterisk/stasis_app_recording.h (original)
+++ team/dlee/record/include/asterisk/stasis_app_recording.h Fri Jun  7 13:33:58 2013
@@ -81,9 +81,8 @@
 	 *  \c STASIS_APP_RECORDING_TERMINATE_ANY to terminate on any DTMF
 	 */
 	char terminate_on;
+	/*! How to handle recording when a file already exists */
 	enum stasis_app_recording_if_exists if_exists;
-	/*! If true, file is appended to instead of overwriting. */
-	int append:1;
 	/*! If true, a beep is played at the start of recording */
 	int beep:1;
 };
@@ -170,12 +169,25 @@
  */
 struct stasis_app_recording *stasis_app_recording_find_by_name(const char *name);
 
+/*!
+ * \brief Construct a JSON model of a recording.
+ *
+ * \param recording Recording to conver.
+ * \return JSON model.
+ * \return \c NULL on error.
+ */
 struct ast_json *stasis_app_recording_to_json(
 	const struct stasis_app_recording *recording);
 
+/*!
+ * \brief Possible results from a recording operation.
+ */
 enum stasis_app_recording_oper_results {
+	/*! Operation completed successfully. */
 	STASIS_APP_RECORDING_OPER_OK,
+	/*! Operation failed. */
 	STASIS_APP_RECORDING_OPER_FAILED,
+	/*! Operation failed b/c recording is not in session. */
 	STASIS_APP_RECORDING_OPER_NOT_RECORDING,
 };