clean up a lot of doxygen errors and warnings (issue #5522)

git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6865 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 10 insertions, 26 deletions

diff --git a/include/asterisk/file.h b/include/asterisk/file.h
index c25837384..147a705d8 100755
--- a/include/asterisk/file.h
+++ b/include/asterisk/file.h
@@ -109,7 +109,7 @@ int ast_filerename(const char *oldname, const char *newname, const char *fmt);
 /*! Deletes a file */
 /*! 
  * \param filename name of the file you wish to delete (minus the extension)
- * \param format of the file
+ * \param fmt of the file
  * Delete a given file in a given format, or if fmt is NULL, then do so for all 
  */
 int ast_filedelete(const char *filename, const char *fmt);
@@ -181,7 +181,7 @@ struct ast_filestream *ast_readfile(const char *filename, const char *type, cons
  * \param filename the name of the file to write to
  * \param type format of file you wish to write out to
  * \param comment comment to go with
- * \param oflags output file flags
+ * \param flags output file flags
  * \param check (unimplemented, hence negligible)
  * \param mode Open mode
  * Create an outgoing file stream.  oflags are flags for the open() command, and 
@@ -239,21 +239,21 @@ struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *fil
 /*! Applys a open stream to a channel. */
 /*!
  * \param chan channel to work
- * \param ast_filestream s to apply
+ * \param s ast_filestream to apply
  * Returns 0 for success, -1 on failure
  */
 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s);
 
 /*! play a open stream on a channel. */
 /*!
- * \param ast_filestream s to play
+ * \param s filestream to play
  * Returns 0 for success, -1 on failure
  */
 int ast_playstream(struct ast_filestream *s);
 
 /*! Seeks into stream */
 /*!
- * \param ast_filestream to perform seek on
+ * \param fs ast_filestream to perform seek on
  * \param sample_offset numbers of samples to seek
  * \param whence SEEK_SET, SEEK_CUR, SEEK_END 
  * Returns 0 for success, or -1 for error
@@ -262,14 +262,14 @@ int ast_seekstream(struct ast_filestream *fs, long sample_offset, int whence);
 
 /*! Trunc stream at current location */
 /*!
- * \param ast_filestream fs 
+ * \param fs filestream to act on
  * Returns 0 for success, or -1 for error
  */
 int ast_truncstream(struct ast_filestream *fs);
 
 /*! Fast forward stream ms */
 /*!
- * \param ast_filestream fs filestream to act on
+ * \param fs filestream to act on
  * \param ms milliseconds to move
  * Returns 0 for success, or -1 for error
  */
@@ -277,23 +277,7 @@ int ast_stream_fastforward(struct ast_filestream *fs, long ms);
 
 /*! Rewind stream ms */
 /*!
- * \param ast_filestream fs filestream to act on
- * \param ms milliseconds to move
- * Returns 0 for success, or -1 for error
- */
-int ast_stream_rewind(struct ast_filestream *fs, long ms);
-
-/*! Fast forward stream ms */
-/*!
- * \param ast_filestream fs filestream to act on
- * \param ms milliseconds to move
- * Returns 0 for success, or -1 for error
- */
-int ast_stream_fastforward(struct ast_filestream *fs, long ms);
-
-/*! Rewind stream ms */
-/*!
- * \param ast_filestream fs filestream to act on
+ * \param fs filestream to act on
  * \param ms milliseconds to move
  * Returns 0 for success, or -1 for error
  */
@@ -301,14 +285,14 @@ int ast_stream_rewind(struct ast_filestream *fs, long ms);
 
 /*! Tell where we are in a stream */
 /*!
- * \param ast_filestream fs to act on
+ * \param fs fs to act on
  * Returns a long as a sample offset into stream
  */
 long ast_tellstream(struct ast_filestream *fs);
 
 /*! Read a frame from a filestream */
 /*!
- * \param ast_filestream fs to act on
+ * \param s ast_filestream to act on
  * Returns a frame or NULL if read failed
  */ 
 struct ast_frame *ast_readframe(struct ast_filestream *s);