diff options
author | markster <markster@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-01-15 23:48:12 +0000 |
---|---|---|
committer | markster <markster@f38db490-d61c-443f-a65b-d21fe96a405b> | 2005-01-15 23:48:12 +0000 |
commit | 597c75ce7b9c35e5dd0ace49462bd02efcd2e5a1 (patch) | |
tree | 148de50e79eba09c6f90abf29b6509e0dbb264db /include/asterisk/file.h | |
parent | ef642e2e7834df16533a3513c7efe663e0a791c8 (diff) |
Repair // comments to /* */ comments (bug #3347)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@4806 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/file.h')
-rwxr-xr-x | include/asterisk/file.h | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/include/asterisk/file.h b/include/asterisk/file.h index 1686914df..f2b9766b7 100755 --- a/include/asterisk/file.h +++ b/include/asterisk/file.h @@ -24,7 +24,7 @@ extern "C" { #endif -//! Convenient for waiting +/*! Convenient for waiting */ #define AST_DIGIT_ANY "0123456789#*" #define SEEK_FORCECUR 10 @@ -33,7 +33,7 @@ extern "C" { pointer for use by the stream manager */ struct ast_filestream; -//! Registers a new file format +/*! Registers a new file format */ /*! Register a new file format capability * Adds a format to asterisk's format abilities. Fill in the fields, and it will work. For examples, look at some of the various format code. * returns 0 on success, -1 on failure @@ -49,7 +49,7 @@ int ast_format_register(const char *name, const char *exts, int format, void (*close)(struct ast_filestream *), char * (*getcomment)(struct ast_filestream *)); -//! Unregisters a file format +/*! Unregisters a file format */ /*! * \param name the name of the format you wish to unregister * Unregisters a format based on the name of the format. @@ -57,7 +57,7 @@ int ast_format_register(const char *name, const char *exts, int format, */ int ast_format_unregister(const char *name); -//! Streams a file +/*! Streams a file */ /*! * \param c channel to stream the file to * \param filename the name of the file you wish to stream, minus the extension @@ -68,7 +68,7 @@ int ast_format_unregister(const char *name); */ int ast_streamfile(struct ast_channel *c, const char *filename, const char *preflang); -//! Stops a stream +/*! Stops a stream */ /*! * \param c The channel you wish to stop playback on * Stop playback of a stream @@ -76,7 +76,7 @@ int ast_streamfile(struct ast_channel *c, const char *filename, const char *pref */ int ast_stopstream(struct ast_channel *c); -//! Checks for the existence of a given file +/*! Checks for the existence of a given file */ /*! * \param filename name of the file you wish to check, minus the extension * \param fmt the format you wish to check (the extension) @@ -86,7 +86,7 @@ int ast_stopstream(struct ast_channel *c); */ int ast_fileexists(const char *filename, const char *fmt, const char *preflang); -//! Renames a file +/*! Renames a file */ /*! * \param oldname the name of the file you wish to act upon (minus the extension) * \param newname the name you wish to rename the file to (minus the extension) @@ -96,7 +96,7 @@ int ast_fileexists(const char *filename, const char *fmt, const char *preflang); */ int ast_filerename(const char *oldname, const char *newname, const char *fmt); -//! Deletes a file +/*! Deletes a file */ /*! * \param filename name of the file you wish to delete (minus the extension) * \param format of the file @@ -104,7 +104,7 @@ int ast_filerename(const char *oldname, const char *newname, const char *fmt); */ int ast_filedelete(const char *filename, const char *fmt); -//! Copies a file +/*! Copies a file */ /*! * \param oldname name of the file you wish to copy (minus extension) * \param newname name you wish the file to be copied to (minus extension) @@ -113,7 +113,7 @@ int ast_filedelete(const char *filename, const char *fmt); */ int ast_filecopy(const char *oldname, const char *newname, const char *fmt); -//! Waits for a stream to stop or digit to be pressed +/*! Waits for a stream to stop or digit to be pressed */ /*! * \param c channel to waitstram on * \param breakon string of DTMF digits to break upon @@ -123,7 +123,7 @@ int ast_filecopy(const char *oldname, const char *newname, const char *fmt); */ char ast_waitstream(struct ast_channel *c, const char *breakon); -//! Same as waitstream but allows stream to be forwarded or rewound +/*! Same as waitstream but allows stream to be forwarded or rewound */ /*! * \param c channel to waitstram on * \param breakon string of DTMF digits to break upon @@ -140,7 +140,7 @@ char ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *f 1 if monfd is ready for reading */ char ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd); -//! Starts reading from a file +/*! Starts reading from a file */ /*! * \param filename the name of the file to read from * \param type format of file you wish to read from @@ -156,7 +156,7 @@ char ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd */ struct ast_filestream *ast_readfile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode); -//! Starts writing a file +/*! Starts writing a file */ /*! * \param filename the name of the file to write to * \param type format of file you wish to write out to @@ -172,7 +172,7 @@ struct ast_filestream *ast_readfile(const char *filename, const char *type, cons */ struct ast_filestream *ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode); -//! Writes a frame to a stream +/*! Writes a frame to a stream */ /*! * \param fs filestream to write to * \param f frame to write to the filestream @@ -181,7 +181,7 @@ struct ast_filestream *ast_writefile(const char *filename, const char *type, con */ int ast_writestream(struct ast_filestream *fs, struct ast_frame *f); -//! Closes a stream +/*! Closes a stream */ /*! * \param f filestream to close * Close a playback or recording stream @@ -189,7 +189,7 @@ int ast_writestream(struct ast_filestream *fs, struct ast_frame *f); */ int ast_closestream(struct ast_filestream *f); -//! Opens stream for use in seeking, playing +/*! Opens stream for use in seeking, playing */ /*! * \param chan channel to work with * \param filename to use @@ -198,7 +198,7 @@ int ast_closestream(struct ast_filestream *f); */ struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang); -//! Opens stream for use in seeking, playing +/*! Opens stream for use in seeking, playing */ /*! * \param chan channel to work with * \param filename to use @@ -207,7 +207,7 @@ struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *file * Returns a ast_filestream pointer if it opens the file, NULL on error */ struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char *filename, const char *preflang, int asis); -//! Opens stream for use in seeking, playing +/*! Opens stream for use in seeking, playing */ /*! * \param chan channel to work with * \param filename to use @@ -216,7 +216,7 @@ struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char */ struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang); -//! Applys a open stream to a channel. +/*! Applys a open stream to a channel. */ /*! * \param chan channel to work * \param ast_filestream s to apply @@ -224,14 +224,14 @@ struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *fil */ int ast_applystream(struct ast_channel *chan, struct ast_filestream *s); -//! play a open stream on a channel. +/*! play a open stream on a channel. */ /*! * \param ast_filestream s to play * Returns 0 for success, -1 on failure */ int ast_playstream(struct ast_filestream *s); -//! Seeks into stream +/*! Seeks into stream */ /*! * \param ast_filestream to perform seek on * \param sample_offset numbers of samples to seek @@ -240,14 +240,14 @@ int ast_playstream(struct ast_filestream *s); */ int ast_seekstream(struct ast_filestream *fs, long sample_offset, int whence); -//! Trunc stream at current location +/*! Trunc stream at current location */ /*! * \param ast_filestream fs * Returns 0 for success, or -1 for error */ int ast_truncstream(struct ast_filestream *fs); -//! Fast forward stream ms +/*! Fast forward stream ms */ /*! * \param ast_filestream fs filestream to act on * \param ms milliseconds to move @@ -255,7 +255,7 @@ int ast_truncstream(struct ast_filestream *fs); */ int ast_stream_fastforward(struct ast_filestream *fs, long ms); -//! Rewind stream ms +/*! Rewind stream ms */ /*! * \param ast_filestream fs filestream to act on * \param ms milliseconds to move @@ -263,7 +263,7 @@ int ast_stream_fastforward(struct ast_filestream *fs, long ms); */ int ast_stream_rewind(struct ast_filestream *fs, long ms); -//! Fast forward stream ms +/*! Fast forward stream ms */ /*! * \param ast_filestream fs filestream to act on * \param ms milliseconds to move @@ -271,7 +271,7 @@ int ast_stream_rewind(struct ast_filestream *fs, long ms); */ int ast_stream_fastforward(struct ast_filestream *fs, long ms); -//! Rewind stream ms +/*! Rewind stream ms */ /*! * \param ast_filestream fs filestream to act on * \param ms milliseconds to move @@ -279,21 +279,21 @@ int ast_stream_fastforward(struct ast_filestream *fs, long ms); */ int ast_stream_rewind(struct ast_filestream *fs, long ms); -//! Tell where we are in a stream +/*! Tell where we are in a stream */ /*! * \param ast_filestream 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 +/*! Read a frame from a filestream */ /*! * \param ast_filestream fs to act on * Returns a frame or NULL if read failed */ struct ast_frame *ast_readframe(struct ast_filestream *s); -//! Initialize file stuff +/*! Initialize file stuff */ /*! * Initializes all the various file stuff. Basically just registers the cli stuff * Returns 0 all the time |