Commit f7eab326 authored by Ghislain MARY's avatar Ghislain MARY

Fix some documentation generation warnings.

parent 2719b541
...@@ -81,7 +81,7 @@ ...@@ -81,7 +81,7 @@
*/ */
/** /**
* @defgroup mediastreamer2_init Starting mediastreamer2 library * @defgroup mediastreamer2_init Init API - Starting mediastreamer2 library
* @ingroup mediastreamer2_api * @ingroup mediastreamer2_api
* @brief Starting mediastreamer2 library * @brief Starting mediastreamer2 library
*/ */
......
...@@ -92,7 +92,7 @@ cards' filters: ...@@ -92,7 +92,7 @@ cards' filters:
ms_filter_call_method(soundwrite,MS_FILTER_SET_NCHANNELS, &chan); ms_filter_call_method(soundwrite,MS_FILTER_SET_NCHANNELS, &chan);
/* if you have some fmtp parameters (from SDP for example!) /* if you have some fmtp parameters (from SDP for example!) */
char *fmtp1 = ** get your fmtp line **; char *fmtp1 = ** get your fmtp line **;
char *fmtp2 = ** get your fmtp line **; char *fmtp2 = ** get your fmtp line **;
ms_filter_call_method(stream->encoder,MS_FILTER_ADD_FMTP, (void*)fmtp1); ms_filter_call_method(stream->encoder,MS_FILTER_ADD_FMTP, (void*)fmtp1);
......
...@@ -267,7 +267,7 @@ MS2_PUBLIC void ice_check_list_destroy(IceCheckList *cl); ...@@ -267,7 +267,7 @@ MS2_PUBLIC void ice_check_list_destroy(IceCheckList *cl);
/** /**
* Tell whether ICE local candidates have been gathered for an ICE check list or not. * Tell whether ICE local candidates have been gathered for an ICE check list or not.
* *
* @param session A pointer to a check list * @param cl A pointer to a check list
* @return TRUE if local candidates have been gathered for the check list, FALSE otherwise. * @return TRUE if local candidates have been gathered for the check list, FALSE otherwise.
*/ */
MS2_PUBLIC bool_t ice_check_list_candidates_gathered(const IceCheckList *cl); MS2_PUBLIC bool_t ice_check_list_candidates_gathered(const IceCheckList *cl);
...@@ -755,7 +755,7 @@ void ice_handle_stun_packet(IceCheckList* cl, RtpSession* rtp_session, const Ort ...@@ -755,7 +755,7 @@ void ice_handle_stun_packet(IceCheckList* cl, RtpSession* rtp_session, const Ort
* @param cl A pointer to a check list * @param cl A pointer to a check list
* @param rtp_addr A pointer to the buffer to use to store the remote RTP address * @param rtp_addr A pointer to the buffer to use to store the remote RTP address
* @param rtp_port A pointer to the location to store the RTP port to * @param rtp_port A pointer to the location to store the RTP port to
* @param rtcp_aadr A pointer to the buffer to use to store the remote RTCP address * @param rtcp_addr A pointer to the buffer to use to store the remote RTCP address
* @param rtcp_port A pointer to the location to store the RTCP port to * @param rtcp_port A pointer to the location to store the RTCP port to
* @param addr_len The size of the buffer to use to store the remote addresses * @param addr_len The size of the buffer to use to store the remote addresses
* *
......
...@@ -93,6 +93,9 @@ typedef enum StreamType { ...@@ -93,6 +93,9 @@ typedef enum StreamType {
VideoStreamType VideoStreamType
} StreamType; } StreamType;
/**
* The MediaStream is an object describing a stream (one of AudioStream or VideoStream).
**/
typedef struct _MediaStream MediaStream; typedef struct _MediaStream MediaStream;
/* /*
...@@ -221,7 +224,7 @@ MS2_PUBLIC int media_stream_set_target_network_bitrate(MediaStream *stream,int t ...@@ -221,7 +224,7 @@ MS2_PUBLIC int media_stream_set_target_network_bitrate(MediaStream *stream,int t
/** /**
* get the stream target bitrate. * get the stream target bitrate.
* @param stream stream to apply parameter on * @param stream stream to apply parameter on
* @param target_bitrate in bit per seconds * @return target_bitrate in bit per seconds
* */ * */
MS2_PUBLIC int media_stream_get_target_network_bitrate(const MediaStream *stream); MS2_PUBLIC int media_stream_get_target_network_bitrate(const MediaStream *stream);
...@@ -322,18 +325,18 @@ MS2_PUBLIC int audio_stream_start_with_files (AudioStream * stream, RtpProfile * ...@@ -322,18 +325,18 @@ MS2_PUBLIC int audio_stream_start_with_files (AudioStream * stream, RtpProfile *
* *
* *
* @param stream an AudioStream previously created with audio_stream_new(). * @param stream an AudioStream previously created with audio_stream_new().
* @param prof a RtpProfile containing all PayloadType possible during the audio session. * @param profile a RtpProfile containing all PayloadType possible during the audio session.
* @param rem_rtp_ip remote IP address where to send the encoded audio. * @param rem_rtp_ip remote IP address where to send the encoded audio.
* @param rem_rtp_port remote IP port where to send the encoded audio. * @param rem_rtp_port remote IP port where to send the encoded audio.
* @param rem_rtcp_ip remote IP address for RTCP. * @param rem_rtcp_ip remote IP address for RTCP.
* @param rem_rtcp_port remote port for RTCP. * @param rem_rtcp_port remote port for RTCP.
* @param payload_type payload type index to use for the sending stream. This index must point to a valid PayloadType in the RtpProfile. * @param payload payload type index to use for the sending stream. This index must point to a valid PayloadType in the RtpProfile.
* @param jitt_comp Nominal jitter buffer size in milliseconds. * @param jitt_comp Nominal jitter buffer size in milliseconds.
* @param infile path to wav file to play out (can be NULL) * @param infile path to wav file to play out (can be NULL)
* @param outfile path to wav file to record into (can be NULL) * @param outfile path to wav file to record into (can be NULL)
* @param playcard The soundcard to be used for playback (can be NULL) * @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 captcard The soundcard to be used for catpure. (can be NULL)
* @param echo_cancel whether echo cancellation is to be performed. * @param use_ec whether echo cancellation is to be performed.
* @returns 0 if sucessful, -1 otherwise. * @returns 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, MS2_PUBLIC int audio_stream_start_full(AudioStream *stream, RtpProfile *profile, const char *rem_rtp_ip,int rem_rtp_port,
...@@ -359,8 +362,8 @@ MS2_PUBLIC void audio_stream_play_received_dtmfs(AudioStream *st, bool_t yesno); ...@@ -359,8 +362,8 @@ MS2_PUBLIC void audio_stream_play_received_dtmfs(AudioStream *st, bool_t yesno);
**/ **/
MS2_PUBLIC AudioStream *audio_stream_new(int loc_rtp_port, int loc_rtcp_port, bool_t ipv6); MS2_PUBLIC AudioStream *audio_stream_new(int loc_rtp_port, int loc_rtcp_port, bool_t ipv6);
/**Creates an AudioStream object from an initialized RtpSession. /**Creates an AudioStream object from initialized MSMediaStreamSessions.
* @param rtp_session the RtpSession * @param sessions the MSMediaStreamSessions
* @returns a new AudioStream * @returns a new AudioStream
**/ **/
MS2_PUBLIC AudioStream *audio_stream_new_with_sessions(const MSMediaStreamSessions *sessions); MS2_PUBLIC AudioStream *audio_stream_new_with_sessions(const MSMediaStreamSessions *sessions);
......
...@@ -163,8 +163,7 @@ MS2_PUBLIC MSList *ms_list_copy(const MSList *list); ...@@ -163,8 +163,7 @@ MS2_PUBLIC MSList *ms_list_copy(const MSList *list);
*/ */
/** /**
* @defgroup mediastreamer2_init Init API - manage mediastreamer2 library. * @addtogroup mediastreamer2_init
* @ingroup mediastreamer2_api
* @{ * @{
*/ */
......
...@@ -105,6 +105,7 @@ MS2_PUBLIC void ms_audio_conference_remove_member(MSAudioConference *obj, MSAudi ...@@ -105,6 +105,7 @@ MS2_PUBLIC void ms_audio_conference_remove_member(MSAudioConference *obj, MSAudi
* *
* @param obj the conference * @param obj the conference
* @param ep the participant, represented as a MSAudioEndpoint object * @param ep the participant, represented as a MSAudioEndpoint object
* @param muted true to mute the participant, false to unmute.
* *
* By default all participants are unmuted. * By default all participants are unmuted.
**/ **/
...@@ -174,7 +175,6 @@ MS2_PUBLIC void ms_audio_endpoint_release_from_stream(MSAudioEndpoint *obj); ...@@ -174,7 +175,6 @@ MS2_PUBLIC void ms_audio_endpoint_release_from_stream(MSAudioEndpoint *obj);
/** /**
* Creates an audio endpoint (or virtual participant) to record the conference into a wav file. * Creates an audio endpoint (or virtual participant) to record the conference into a wav file.
* @param path Path to the wav file to record.
**/ **/
MS2_PUBLIC MSAudioEndpoint * ms_audio_endpoint_new_recorder(void); MS2_PUBLIC MSAudioEndpoint * ms_audio_endpoint_new_recorder(void);
......
...@@ -37,8 +37,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ...@@ -37,8 +37,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/ */
/** /**
* @defgroup mediastreamer2_filter Filter API - manage mediastreamer2 filters. * @addtogroup mediastreamer2_filter
* @ingroup mediastreamer2_api
* @{ * @{
*/ */
...@@ -292,7 +291,7 @@ MS2_PUBLIC MSFilterDesc * ms_filter_get_decoder(const char *mime); ...@@ -292,7 +291,7 @@ MS2_PUBLIC MSFilterDesc * ms_filter_get_decoder(const char *mime);
* This descriptor can be used to instanciate the filter using ms_filter_new_from_desc() * This descriptor can be used to instanciate the filter using ms_filter_new_from_desc()
* This function can be useful to query the presence of a filter loaded as a plugin, for example. * This function can be useful to query the presence of a filter loaded as a plugin, for example.
* *
* @param name The filter name. * @param filter_name The filter name.
**/ **/
MS2_PUBLIC MSFilterDesc *ms_filter_lookup_by_name(const char *filter_name); MS2_PUBLIC MSFilterDesc *ms_filter_lookup_by_name(const char *filter_name);
...@@ -478,8 +477,6 @@ MS2_PUBLIC void ms_filter_add_notify_callback(MSFilter *f, MSFilterNotifyFunc fn ...@@ -478,8 +477,6 @@ MS2_PUBLIC void ms_filter_add_notify_callback(MSFilter *f, MSFilterNotifyFunc fn
* @param f A MSFilter object. * @param f A MSFilter object.
* @param fn A MSFilterNotifyFunc that will be called. * @param fn A MSFilterNotifyFunc that will be called.
* @param userdata A pointer to private data. * @param userdata A pointer to private data.
* @param synchronous boolean that indicates whether this callback must be called synchronously.
* @deprecated use ms_filter_add_notify_callback()
* *
*/ */
MS2_PUBLIC void ms_filter_remove_notify_callback(MSFilter *f, MSFilterNotifyFunc fn, void *userdata); MS2_PUBLIC void ms_filter_remove_notify_callback(MSFilter *f, MSFilterNotifyFunc fn, void *userdata);
......
...@@ -32,8 +32,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ...@@ -32,8 +32,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/ */
/** /**
* @defgroup mediastreamer2_soundcard Sound Card API - manage audio capture/play filters. * @addtogroup mediastreamer2_soundcard
* @ingroup mediastreamer2_api
* @{ * @{
*/ */
...@@ -275,7 +274,7 @@ MS2_PUBLIC MSSndCard * ms_snd_card_new(MSSndCardDesc *desc); ...@@ -275,7 +274,7 @@ MS2_PUBLIC MSSndCard * ms_snd_card_new(MSSndCardDesc *desc);
* Create a new sound card object. * Create a new sound card object.
* *
* @param desc A sound card description object. * @param desc A sound card description object.
* @param card mame * @param name The card name
* *
* Returns: MSSndCard if successfull, NULL otherwise. * Returns: MSSndCard if successfull, NULL otherwise.
*/ */
...@@ -416,7 +415,7 @@ MS2_PUBLIC void ms_snd_card_set_capture(MSSndCard *obj, MSSndCardCapture c); ...@@ -416,7 +415,7 @@ MS2_PUBLIC void ms_snd_card_set_capture(MSSndCard *obj, MSSndCardCapture c);
* *
* @param obj A sound card object. * @param obj A sound card object.
* @param e A sound card control object. * @param e A sound card control object.
* @param percent A value for control. * @param val A value for control.
* *
* Returns: 0 if successfull, <0 otherwise. * Returns: 0 if successfull, <0 otherwise.
*/ */
......
...@@ -33,8 +33,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ...@@ -33,8 +33,7 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/ */
/** /**
* @defgroup mediastreamer2_ticker Ticker API - manage mediastreamer2 graphs. * @addtogroup mediastreamer2_ticker
* @ingroup mediastreamer2_api
* @{ * @{
*/ */
......
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