Doxygen: replace invalid @returns with @return

parent 74589ad4
......@@ -30,4 +30,4 @@ namespace mediastreamer2_tester_native
Platform::String^ testName(Platform::String^ suiteName, int testIndex);
void run(Platform::String^ suiteName, Platform::String^ caseName, Platform::Boolean verbose);
};
}
\ No newline at end of file
}
......@@ -15,4 +15,4 @@ namespace mediastreamer2_tester_native
private:
Mediastreamer2TesterVideoPrivate *d;
};
}
\ No newline at end of file
}
......@@ -255,7 +255,7 @@ MS2_PUBLIC void media_stream_iterate(MediaStream * stream);
MS2_PUBLIC bool_t media_stream_alive(MediaStream *stream, int timeout_seconds);
/**
* @returns curret streams tate
* @return curret streams tate
* */
MS2_PUBLIC MSStreamState media_stream_get_state(const MediaStream *stream);
......@@ -358,7 +358,7 @@ MS2_PUBLIC int audio_stream_start_with_files (AudioStream * stream, RtpProfile *
* @param playcard The soundcard to be used for playback (can be NULL)
* @param captcard The soundcard to be used for catpure. (can be NULL)
* @param use_ec whether echo cancellation is to be performed.
* @returns 0 if sucessful, -1 otherwise.
* @return 0 if sucessful, -1 otherwise.
**/
MS2_PUBLIC int audio_stream_start_full(AudioStream *stream, RtpProfile *profile, const char *rem_rtp_ip,int rem_rtp_port,
const char *rem_rtcp_ip, int rem_rtcp_port, int payload,int jitt_comp, const char *infile, const char *outfile,
......@@ -379,13 +379,13 @@ MS2_PUBLIC void audio_stream_play_received_dtmfs(AudioStream *st, bool_t yesno);
* @param loc_rtp_port the local UDP port to listen for RTP packets.
* @param loc_rtcp_port the local UDP port to listen for RTCP packets
* @param ipv6 TRUE if ipv6 must be used.
* @returns a new AudioStream.
* @return a new AudioStream.
**/
MS2_PUBLIC AudioStream *audio_stream_new(int loc_rtp_port, int loc_rtcp_port, bool_t ipv6);
/**Creates an AudioStream object from initialized MSMediaStreamSessions.
* @param sessions the MSMediaStreamSessions
* @returns a new AudioStream
* @return a new AudioStream
**/
MS2_PUBLIC AudioStream *audio_stream_new_with_sessions(const MSMediaStreamSessions *sessions);
......
......@@ -55,7 +55,7 @@ MS2_PUBLIC unsigned int ms_concealer_context_is_concealement_required(MSConceale
* @param current_time the current time in milliseconds, as pointed by f->ticker->time.
* @param time_increment the number of milliseconds of audio decoded.
* @param got_packet set to 1 if a real frame was decoded, 0 if it was a PLC frame.
* @returns if a PLC period terminates, returns the duration of this PLC period in milliseconds, 0 otherwise.
* @return if a PLC period terminates, returns the duration of this PLC period in milliseconds, 0 otherwise.
**/
MS2_PUBLIC int ms_concealer_inc_sample_time(MSConcealerContext* obj, uint64_t current_time, int time_increment, int got_packet);
......@@ -92,7 +92,7 @@ MS2_PUBLIC unsigned int ms_concealer_ts_context_is_concealement_required(MSConce
* @param current_ts the current time converted in timestamp units, usually (f->ticker->time*clock_rate)/1000
* @param ts_increment the duration of audio decoded expressed in timestamp units
* @param got_packet set to 1 if a real frame was decoded, 0 if it was a PLC frame.
* @returns if a PLC period terminates, returns the duration of this PLC period in timestamp units, 0 otherwise.
* @return if a PLC period terminates, returns the duration of this PLC period in timestamp units, 0 otherwise.
**/
MS2_PUBLIC int ms_concealer_ts_context_inc_sample_ts(MSConcealerTsContext* obj, uint64_t current_ts, int ts_increment, int got_packet);
......
......@@ -75,14 +75,14 @@ extern "C" {
/**
* Creates a conference.
* @param params a MSAudioConferenceParams structure, containing conference parameters.
* @returns a MSAudioConference object.
* @return a MSAudioConference object.
**/
MS2_PUBLIC MSAudioConference * ms_audio_conference_new(const MSAudioConferenceParams *params);
/**
* Gets conference's current parameters.
* @param obj the conference.
* @returns a read-only pointer to the conference parameters.
* @return a read-only pointer to the conference parameters.
**/
MS2_PUBLIC const MSAudioConferenceParams *ms_audio_conference_get_params(MSAudioConference *obj);
......
......@@ -134,7 +134,7 @@ MS2_PUBLIC MSFilterDesc* ms_factory_lookup_filter_by_id( MSFactory* factory, MSF
* Returns a list of filter descriptions implementing a given interface.
* The list itself must be freed by the caller of this function, but not the MSFilterDesc pointed by the list elements.
* @param id a filter interface id
* @returns a newly allocated MSList of #MSFilterDesc.
* @return a newly allocated MSList of #MSFilterDesc.
**/
MSList *ms_factory_lookup_filter_by_interface(MSFactory *factory, MSFilterInterfaceId id);
......
......@@ -301,7 +301,7 @@ MS2_PUBLIC MSFilterDesc *ms_filter_lookup_by_name(const char *filter_name);
* Returns a list of filter descriptions implementing a given interface.
* The list itself must be freed by the caller of this function, but not the MSFilterDesc pointed by the list elements.
* @param id a filter interface id
* @returns a newly allocated MSList of #MSFilterDesc.
* @return a newly allocated MSList of #MSFilterDesc.
**/
MSList *ms_filter_lookup_by_interface(MSFilterInterfaceId id);
......
......@@ -47,4 +47,4 @@ extern "C"{
}
#endif
#endif /* VIDEOSTARTER_H */
\ No newline at end of file
#endif /* VIDEOSTARTER_H */
......@@ -37,4 +37,4 @@ private:
}//end of namespace
#endif
\ No newline at end of file
#endif
......@@ -23,4 +23,4 @@
#include <jni.h>
jobject enable_hardware_echo_canceller(JNIEnv *env, int sessionId);
void delete_hardware_echo_canceller(JNIEnv *env, jobject aec);
\ No newline at end of file
void delete_hardware_echo_canceller(JNIEnv *env, jobject aec);
......@@ -129,4 +129,4 @@ extern "C"{
}
#endif
#endif /* VP8RTPFMT_H */
\ No newline at end of file
#endif /* VP8RTPFMT_H */
......@@ -72,4 +72,4 @@ PayloadType* ms_tools_parse_custom_payload(const char *name){
}
fprintf(stderr,"Error parsing payload name %s.\n",name);
exit(-1);
}
\ No newline at end of file
}
......@@ -21,4 +21,4 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#include "mediastreamer2/mediastream.h"
PayloadType* ms_tools_parse_custom_payload(const char *name);
\ No newline at end of file
PayloadType* ms_tools_parse_custom_payload(const char *name);
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment