Skip to content

Commit

Permalink
Fixed small typos in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lminiero committed Oct 10, 2016
1 parent 7ea4c1e commit 13913e3
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 10 deletions.
4 changes: 1 addition & 3 deletions ice.h
Original file line number Diff line number Diff line change
Expand Up @@ -529,9 +529,7 @@ void janus_ice_cb_new_selected_pair (NiceAgent *agent, guint stream_id, guint co
#endif
/*! \brief libnice callback to notify when a new remote candidate has been discovered for an ICE agent
* @param[in] agent The libnice agent for which the callback applies
* @param[in] stream_id The stream ID for which the callback applies
* @param[in] component_id The component ID for which the callback applies
* @param[in] foundation Candidate (or foundation)
* @param[in] candidate The libnice candidate that has been discovered
* @param[in] ice Opaque pointer to the Janus ICE handle associated with the libnice ICE agent */
#ifndef HAVE_LIBNICE_TCP
void janus_ice_cb_new_remote_candidate (NiceAgent *agent, guint stream_id, guint component_id, gchar *candidate, gpointer ice);
Expand Down
5 changes: 3 additions & 2 deletions janus.h
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ struct janus_request {
* @param[in] transport Pointer to the transport
* @param[in] instance Opaque pointer to the transport-provided instance
* @param[in] request_id Opaque pointer to the request ID, if available
* @param[in] admin Whether this is a Janus API or Admin API request
* @param[in] message Opaque pointer to the original request, if available
* @returns A pointer to a janus_request instance if successful, NULL otherwise */
janus_request *janus_request_new(janus_transport *transport, void *instance, void *request_id, gboolean admin, json_t *message);
Expand All @@ -121,7 +122,6 @@ janus_request *janus_request_new(janus_transport *transport, void *instance, voi
* @note The opaque pointers in the instance are not destroyed, that's up to you */
void janus_request_destroy(janus_request *request);
/*! \brief Helper to process an incoming request, no matter where it comes from
* @param[in] source The request instance and its source
* @param[in] request The JSON request
* @returns 0 on success, a negative integer otherwise
*/
Expand All @@ -133,6 +133,7 @@ int janus_process_incoming_request(janus_request *request);
int janus_process_incoming_admin_request(janus_request *request);
/*! \brief Method to return a successful Janus response message (JSON) to the browser
* @param[in] request The request instance and its source
* @param[in] payload The payload to return as a JSON object
* @returns 0 on success, a negative integer otherwise
*/
int janus_process_success(janus_request *request, json_t *payload);
Expand All @@ -146,7 +147,7 @@ int janus_process_success(janus_request *request, json_t *payload);
* associated with the error code is used
* @returns 0 on success, a negative integer otherwise
*/
int janus_process_error(janus_request *source, uint64_t session_id, const char *transaction, gint error, const char *format, ...) G_GNUC_PRINTF(5, 6);
int janus_process_error(janus_request *request, uint64_t session_id, const char *transaction, gint error, const char *format, ...) G_GNUC_PRINTF(5, 6);
///@}


Expand Down
1 change: 0 additions & 1 deletion log.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

/*! \brief Buffered vprintf
* @param[in] format Format string as defined by glib
* @param[in] args Parameters to insert into formatted string
* \note This output is buffered and may not appear immediately on stdout. */
void janus_vprintf(const char *format, ...) G_GNUC_PRINTF(1, 2);

Expand Down
2 changes: 1 addition & 1 deletion mainpage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
* HTTP/WebSocket JavaScript API to use the gateway and the plugins it
* makes available in your web application can be found in the \ref JS
* and \ref rest pages. New API transports can be created referring to
* the \transportapi page. If you're interested in monitoring Janus
* the \ref transportapi page. If you're interested in monitoring Janus
* resources, you can refer to the \ref admin page.
*
* Finally, some information on how to deploy Janus and your web
Expand Down
2 changes: 1 addition & 1 deletion sdp.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
/*! \brief Method to pre-parse a session description
* \details This method is only used to quickly check how many audio and video lines are in an SDP, and to generate a Janus SDP instance
* @param[in] jsep_sdp The SDP that the browser peer originated
* @param[in,out] error Buffer to receive a reason for an error, if any
* @param[in,out] error_str Buffer to receive a reason for an error, if any
* @param[in] errlen The length of the error buffer
* @param[out] audio The number of audio m-lines
* @param[out] video The number of video m-lines
Expand Down
3 changes: 1 addition & 2 deletions utils.h
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ int janus_pidfile_remove(void);
/*! \brief Creates a string describing the JSON type and constraint
* @param jtype The JSON type, e.g., JSON_STRING
* @param flags Indicates constraints for the described type
* @param[out] The type description, e.g., "a positive integer"; required size is 19 characters
* @param[out] type_name The type description, e.g., "a positive integer"; required size is 19 characters
* @returns 0 if successful, a negative integer otherwise */
void janus_get_json_type_name(int jtype, unsigned int flags, char *type_name);

Expand Down Expand Up @@ -214,7 +214,6 @@ gboolean janus_json_is_valid(json_t *val, json_type jtype, unsigned int flags);
* @param member The JSON member with the secret, usually "secret" or "pin"
* @param[out] error_code int to return error code
* @param[out] error_cause Array of char or NULL to return the error descriptions; the array has to be a global or stack variable to make sizeof work; the required size is 60
* @param log_error If TRUE, log any error with JANUS_LOG(LOG_ERR)
* @param missing_code The code to be returned in error_code if a parameter is missing
* @param invalid_code The code to be returned in error_code if a parameter is invalid
* @param unauthorized_code The code to be returned in error_code if the secret doesn't match */
Expand Down

0 comments on commit 13913e3

Please sign in to comment.