Skip to content

Commit

Permalink
Update annotations for gobject-introspection
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Matthew committed Feb 1, 2011
1 parent ce64948 commit 9a84078
Show file tree
Hide file tree
Showing 47 changed files with 372 additions and 227 deletions.
12 changes: 6 additions & 6 deletions backends/rb-encoder.c
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ rb_encoder_get_type (void)
*
* Returns the #RBEncoderFactory instance.
*
* Return value: the #RBEncoderFactory
* Return value: (transfer none): the #RBEncoderFactory
*/
RBEncoderFactory *
rb_encoder_factory_get ()
Expand Down Expand Up @@ -266,9 +266,9 @@ rb_encoder_cancel (RBEncoder *encoder)
* rb_encoder_get_media_type:
* @encoder: a #RBEncoder
* @entry: the source #RhythmDBEntry
* @dest_media_types: a #GList of media type strings in order of preference
* @media_type: returns the selected media type, if any
* @extension: returns the file extension associated with the selected media type, if any
* @dest_media_types: (element-type utf8): media type strings in order of preference
* @media_type: (out callee-allocates) (allow-none): returns the selected media type, if any
* @extension: (out callee-allocates) (allow-none): returns the file extension associated with the selected media type, if any
*
* Identifies the first media type in the list that the encoder can actually encode to.
* The file extension (eg. '.mp3' for audio/mpeg) associated with the selected type is
Expand All @@ -292,7 +292,7 @@ rb_encoder_get_media_type (RBEncoder *encoder,
* rb_encoder_get_missing_plugins:
* @encoder: a #RBEncoder
* @media_type: the media type required
* @details: returns plugin installer detail strings
* @details: (out callee-allocates): returns plugin installer detail strings
*
* Retrieves the plugin installer detail strings for any missing plugins
* required to encode the specified media type.
Expand All @@ -313,7 +313,7 @@ rb_encoder_get_missing_plugins (RBEncoder *encoder,
*
* Creates a new #RBEncoder instance.
*
* Return value: the new #RBEncoder
* Return value: (transfer full): the new #RBEncoder
*/
RBEncoder*
rb_encoder_new (void)
Expand Down
6 changes: 3 additions & 3 deletions backends/rb-encoder.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,17 @@ G_BEGIN_DECLS
#define RB_IS_ENCODER_FACTORY_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), RB_TYPE_ENCODER_FACTORY))
#define RB_ENCODER_FACTORY_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), RB_TYPE_ENCODER_FACTORY, RBEncoderFactoryClass))

enum
typedef enum
{
RB_ENCODER_ERROR_FORMAT_UNSUPPORTED,
RB_ENCODER_ERROR_INTERNAL,
RB_ENCODER_ERROR_FILE_ACCESS,
RB_ENCODER_ERROR_OUT_OF_SPACE,
RB_ENCODER_ERROR_DEST_READ_ONLY
};
} RBEncoderError;

GType rb_encoder_error_get_type (void);
#define RB_TYPE_ENCODER_ERROR (rb_encoer_error_get_type())
#define RB_TYPE_ENCODER_ERROR (rb_encoder_error_get_type())
#define RB_ENCODER_ERROR rb_encoder_error_quark ()
GQuark rb_encoder_error_quark (void);

Expand Down
2 changes: 1 addition & 1 deletion backends/rb-player.c
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ rb_player_multiple_open (RBPlayer *player)
*
* Creates a new player object.
*
* Return value: new player object.
* Return value: (transfer full): new player object.
*/
RBPlayer*
rb_player_new (gboolean want_crossfade, GError **error)
Expand Down
2 changes: 1 addition & 1 deletion backends/rb-player.h
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ struct _RBPlayerIface

gboolean (*seekable) (RBPlayer *player);
void (*set_time) (RBPlayer *player,
gint64 time);
gint64 newtime);
gint64 (*get_time) (RBPlayer *player);
gboolean (*multiple_open) (RBPlayer *player);

Expand Down
2 changes: 1 addition & 1 deletion lib/libmediaplayerid/mpid-util.c
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ mpid_error_get_type (void)
{ 0, 0, 0 }
};

etype = g_enum_register_static ("MPIDErrorType", values);
etype = g_enum_register_static ("MPIDError", values);
}

return etype;
Expand Down
2 changes: 1 addition & 1 deletion lib/rb-builder-helpers.c
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* relative to the shared data directory, or its 'ui' or 'art'
* subdirectories.
*
* Return value: #GtkBuilder object built from the file
* Return value: (transfer full): #GtkBuilder object built from the file
*/
GtkBuilder *
rb_builder_load (const char *file, gpointer user_data)
Expand Down
10 changes: 5 additions & 5 deletions lib/rb-debug.c
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ rb_debug_init_match (const char *match)
* this debug output code that will produce the same debug output
* settings.
*
* Return value: debug output arguments, must be freed with #g_strfreev()
* Return value: (transfer full): debug output arguments, must be freed with #g_strfreev()
*/
char **
rb_debug_get_args (void)
Expand Down Expand Up @@ -280,7 +280,7 @@ struct RBProfiler
};

/**
* rb_profiler_new:
* rb_profiler_new: (skip):
* @name: profiler name
*
* Creates a new profiler instance. This can be used to
Expand All @@ -306,7 +306,7 @@ rb_profiler_new (const char *name)
}

/**
* rb_profiler_dump:
* rb_profiler_dump: (skip):
* @profiler: profiler instance
*
* Produces debug output for the profiler instance,
Expand All @@ -330,7 +330,7 @@ rb_profiler_dump (RBProfiler *profiler)
}

/**
* rb_profiler_reset:
* rb_profiler_reset: (skip):
* @profiler: profiler instance
*
* Resets the elapsed time for the profiler
Expand All @@ -347,7 +347,7 @@ rb_profiler_reset (RBProfiler *profiler)
}

/**
* rb_profiler_free:
* rb_profiler_free: (skip):
* @profiler: profiler instance to destroy
*
* Frees the memory associated with a profiler instance.
Expand Down
4 changes: 2 additions & 2 deletions lib/rb-file-helpers.c
Original file line number Diff line number Diff line change
Expand Up @@ -838,7 +838,7 @@ _uri_handle_recurse (GFile *dir,
* rb_uri_handle_recursively:
* @uri: URI to visit
* @cancel: an optional #GCancellable to allow cancellation
* @func: Callback function
* @func: (scope call): Callback function
* @user_data: Data for callback function
*
* Calls @func for each file found under the directory identified by @uri.
Expand Down Expand Up @@ -1384,7 +1384,7 @@ rb_uri_create_parent_dirs (const char *uri, GError **error)
* the nearest extant ancestor of the specified file, which may be
* the file itself if it exists.
*
* Return value: #GFile for the nearest extant ancestor
* Return value: (transfer full): #GFile for the nearest extant ancestor
*/
GFile *
rb_file_find_extant_parent (GFile *file)
Expand Down
2 changes: 1 addition & 1 deletion lib/rb-string-value-map.c
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ rb_string_value_map_peek (RBStringValueMap *map,
* Extracts and returns the underlying hash table from the map,
* and creates a new empty map.
*
* Return value: #GHashTable from the map
* Return value: (transfer full): #GHashTable from the map
*/
GHashTable*
rb_string_value_map_steal_hashtable (RBStringValueMap *map)
Expand Down
Loading

0 comments on commit 9a84078

Please sign in to comment.