diff --git a/gst-libs/gst/video/navigation.c b/gst-libs/gst/video/navigation.c index 800117bcae..d745ae02c8 100644 --- a/gst-libs/gst/video/navigation.c +++ b/gst-libs/gst/video/navigation.c @@ -277,7 +277,8 @@ gst_navigation_query_set_commands (GstQuery * query, gint n_cmds, ...) * gst_navigation_query_set_commandsv: * @query: a #GstQuery * @n_cmds: the number of commands to set. - * @cmds: An array containing @n_cmds @GstNavigationCommand values. + * @cmds: (array length=n_cmds): An array containing @n_cmds + * @GstNavigationCommand values. * * Set the #GstNavigation command query result fields in @query. The number * of commands passed must be equal to @n_commands. @@ -303,7 +304,7 @@ gst_navigation_query_set_commandsv (GstQuery * query, gint n_cmds, /** * gst_navigation_query_parse_commands_length: * @query: a #GstQuery - * @n_cmds: (out): the number of commands in this query. + * @n_cmds: (out) (optional): the number of commands in this query. * * Parse the number of commands in the #GstNavigation commands @query. * @@ -334,7 +335,7 @@ gst_navigation_query_parse_commands_length (GstQuery * query, guint * n_cmds) * gst_navigation_query_parse_commands_nth: * @query: a #GstQuery * @nth: the nth command to retrieve. - * @cmd: (out): a pointer to store the nth command into. + * @cmd: (out) (optional): a pointer to store the nth command into. * * Parse the #GstNavigation command query and retrieve the @nth command from * it into @cmd. If the list contains less elements than @nth, @cmd will be @@ -415,10 +416,10 @@ gst_navigation_query_set_angles (GstQuery * query, guint cur_angle, /** * gst_navigation_query_parse_angles: * @query: a #GstQuery - * @cur_angle: Pointer to a #guint into which to store the currently selected - * angle value from the query, or NULL - * @n_angles: Pointer to a #guint into which to store the number of angles - * value from the query, or NULL + * @cur_angle: (out) (optional): Pointer to a #guint into which to store the + * currently selected angle value from the query, or NULL + * @n_angles: (out) (optional): Pointer to a #guint into which to store the + * number of angles value from the query, or NULL * * Parse the current angle number in the #GstNavigation angles @query into the * #guint pointed to by the @cur_angle variable, and the number of available @@ -522,8 +523,8 @@ gst_navigation_message_new_mouse_over (GstObject * src, gboolean active) /** * gst_navigation_message_parse_mouse_over: * @message: A #GstMessage to inspect. - * @active: A pointer to a gboolean to receive the active/inactive state, - * or NULL. + * @active: (out) (optional): A pointer to a gboolean to receive the + * active/inactive state, or NULL. * * Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER * and extract the active/inactive flag. If the mouse over event is marked @@ -576,8 +577,8 @@ gst_navigation_message_new_event (GstObject * src, GstEvent * event) /** * gst_navigation_message_parse_event: * @message: A #GstMessage to inspect. - * @event: (out) (transfer full): a pointer to a #GstEvent to receive the - * contained navigation event. + * @event: (out) (optional) (transfer full): a pointer to a #GstEvent to receive + * the contained navigation event. * * Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_EVENT * and extract contained #GstEvent. The caller must unref the @event when done @@ -657,9 +658,10 @@ gst_navigation_message_new_angles_changed (GstObject * src, guint cur_angle, /** * gst_navigation_message_parse_angles_changed: * @message: A #GstMessage to inspect. - * @cur_angle: A pointer to a #guint to receive the new current angle number, - * or NULL - * @n_angles: A pointer to a #guint to receive the new angle count, or NULL. + * @cur_angle: (out) (optional): A pointer to a #guint to receive the new + * current angle number, or NULL + * @n_angles: (out) (optional): A pointer to a #guint to receive the new angle + * count, or NULL. * * Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED * and extract the @cur_angle and @n_angles parameters. @@ -734,9 +736,9 @@ gst_navigation_event_get_type (GstEvent * event) /** * gst_navigation_event_parse_key_event: * @event: A #GstEvent to inspect. - * @key: A pointer to a location to receive the string identifying the key - * press. The returned string is owned by the event, and valid only until the - * event is unreffed. + * @key: (out) (optional) (transfer none): A pointer to a location to receive + * the string identifying the key press. The returned string is owned by the + * event, and valid only until the event is unreffed. */ gboolean gst_navigation_event_parse_key_event (GstEvent * event, const gchar ** key) @@ -761,12 +763,12 @@ gst_navigation_event_parse_key_event (GstEvent * event, const gchar ** key) /** * gst_navigation_event_parse_mouse_button_event: * @event: A #GstEvent to inspect. - * @button: Pointer to a gint that will receive the button number associated - * with the event. - * @x: Pointer to a gdouble to receive the x coordinate of the mouse button - * event. - * @y: Pointer to a gdouble to receive the y coordinate of the mouse button - * event. + * @button: (out) (optional): Pointer to a gint that will receive the button + * number associated with the event. + * @x: (out) (optional): Pointer to a gdouble to receive the x coordinate of the + * mouse button event. + * @y: (out) (optional): Pointer to a gdouble to receive the y coordinate of the + * mouse button event. * * Retrieve the details of either a #GstNavigation mouse button press event or * a mouse button release event. Determine which type the event is using @@ -803,8 +805,10 @@ gst_navigation_event_parse_mouse_button_event (GstEvent * event, gint * button, /** * gst_navigation_event_parse_mouse_move_event: * @event: A #GstEvent to inspect. - * @x: Pointer to a gdouble to receive the x coordinate of the mouse movement. - * @y: Pointer to a gdouble to receive the y coordinate of the mouse movement. + * @x: (out) (optional): Pointer to a gdouble to receive the x coordinate of the + * mouse movement. + * @y: (out) (optional): Pointer to a gdouble to receive the y coordinate of the + * mouse movement. * * Inspect a #GstNavigation mouse movement event and extract the coordinates * of the event. @@ -835,8 +839,8 @@ gst_navigation_event_parse_mouse_move_event (GstEvent * event, gdouble * x, /** * gst_navigation_event_parse_command: * @event: A #GstEvent to inspect. - * @command: Pointer to GstNavigationCommand to receive the type of the - * navigation event. + * @command: (out) (optional): Pointer to GstNavigationCommand to receive the + * type of the navigation event. * * Inspect a #GstNavigation command event and retrieve the enum value of the * associated command.