diff options
Diffstat (limited to 'src/itdb_itunesdb.c')
| -rw-r--r-- | src/itdb_itunesdb.c | 68 |
1 files changed, 34 insertions, 34 deletions
diff --git a/src/itdb_itunesdb.c b/src/itdb_itunesdb.c index f9f75c6..66f024d 100644 --- a/src/itdb_itunesdb.c +++ b/src/itdb_itunesdb.c @@ -359,7 +359,7 @@ static void fcontents_free (FContents *cts) * append d to good_path and make the result the new good_path. * Otherwise, we quit and return NULL. * - * Return value: path to track on the iPod or NULL. + * Returns: path to track on the iPod or NULL. */ gchar * itdb_resolve_path (const gchar *root, const gchar * const * components) @@ -1173,7 +1173,7 @@ void itdb_free (Itdb_iTunesDB *itdb) * Duplicate @itdb * FIXME: not implemented yet * - * Return value: always return NULL since it's unimplemented + * Returns: always return NULL since it's unimplemented */ Itdb_iTunesDB *itdb_duplicate (Itdb_iTunesDB *itdb) { @@ -1188,7 +1188,7 @@ Itdb_iTunesDB *itdb_duplicate (Itdb_iTunesDB *itdb) * * Counts the number of playlists stored in @itdb * - * Return value: the number of playlists in @itdb (including the master + * Returns: the number of playlists in @itdb (including the master * playlist) */ guint32 itdb_playlists_number (Itdb_iTunesDB *itdb) @@ -1204,7 +1204,7 @@ guint32 itdb_playlists_number (Itdb_iTunesDB *itdb) * * Counts the number of tracks stored in @itdb * - * Return value: the number of tracks in @itdb + * Returns: the number of tracks in @itdb */ guint32 itdb_tracks_number (Itdb_iTunesDB *itdb) { @@ -1219,7 +1219,7 @@ guint32 itdb_tracks_number (Itdb_iTunesDB *itdb) * * Counts the number of non-transferred tracks in @itdb * - * Return value: the number of tracks in @itdb that haven't been transferred + * Returns: the number of tracks in @itdb that haven't been transferred * to the iPod yet (ie the number of #Itdb_Track in which the transferred field * is false) */ @@ -1244,7 +1244,7 @@ guint32 itdb_tracks_number_nontransferred (Itdb_iTunesDB *itdb) * Creates a new Itdb_iTunesDB with the unknowns filled in to reasonable * values. * - * Return value: a newly created Itdb_iTunesDB to be freed with itdb_free() + * Returns: a newly created Itdb_iTunesDB to be freed with itdb_free() * when it's no longer needed */ Itdb_iTunesDB *itdb_new (void) @@ -2961,7 +2961,7 @@ itdb_parse_internal (Itdb_iTunesDB *itdb, GError **error) * * Parse the Itdb_iTunesDB of the iPod located at @mp * - * Return value: a newly allocated #Itdb_iTunesDB struct holding the tracks and + * Returns: a newly allocated #Itdb_iTunesDB struct holding the tracks and * the playlists present on the iPod at @mp, NULL if @mp isn't an iPod mount * point. If non-NULL, the #Itdb_iTunesDB is to be freed with itdb_free() when * it's no longer needed @@ -3048,7 +3048,7 @@ Itdb_iTunesDB *itdb_parse (const gchar *mp, GError **error) * * Same as itunesdb_parse(), but filename is specified directly. * - * Return value: a newly allocated #Itdb_iTunesDB struct holding the tracks and + * Returns: a newly allocated #Itdb_iTunesDB struct holding the tracks and * the playlists present in @filename, NULL if @filename isn't a parsable * iTunesDB file. If non-NULL, the #Itdb_iTunesDB is to be freed with * itdb_free() when it's no longer needed @@ -5123,7 +5123,7 @@ static gboolean write_db_checksum (FExport *fexp, GError **error) * Write the content of @itdb to @filename. If @filename is NULL, it attempts * to write to @itdb->filename. * - * Return value: TRUE if all went well, FALSE otherwise + * Returns: TRUE if all went well, FALSE otherwise */ gboolean itdb_write_file (Itdb_iTunesDB *itdb, const gchar *filename, GError **error) @@ -5220,7 +5220,7 @@ gboolean itdb_write_file (Itdb_iTunesDB *itdb, const gchar *filename, * An existing "OTGPlaylistInfo" file is removed if the export was * successful. * - * Return value: TRUE on success, FALSE on error, in which case @error is + * Returns: TRUE on success, FALSE on error, in which case @error is * set accordingly. */ gboolean itdb_write (Itdb_iTunesDB *itdb, GError **error) @@ -5387,7 +5387,7 @@ All integers in the iTunesSD file are in BIG endian form... * export was successful. @itdb->mountpoint must point to the mount * point of the iPod, e.g. "/mnt/ipod" and be in local encoding. * - * Return value: TRUE on success, FALSE on error, in which case @error is + * Returns: TRUE on success, FALSE on error, in which case @error is * set accordingly. */ gboolean itdb_shuffle_write (Itdb_iTunesDB *itdb, GError **error) @@ -5450,7 +5450,7 @@ static gboolean haystack (gchar *filetype, gchar **desclist) * * Do the actual writing to the iTunesSD * - * Return value: TRUE on success, FALSE on error, in which case @error is + * Returns: TRUE on success, FALSE on error, in which case @error is * set accordingly. */ gboolean itdb_shuffle_write_file (Itdb_iTunesDB *itdb, @@ -5575,7 +5575,7 @@ gboolean itdb_shuffle_write_file (Itdb_iTunesDB *itdb, * directly to the iPod but to some other location and then manually * copy the file from there to the iPod. * - * Return value: FALSE on error and sets @error accordingly + * Returns: FALSE on error and sets @error accordingly */ gboolean itdb_rename_files (const gchar *mp, GError **error) { @@ -5717,7 +5717,7 @@ void itdb_set_mountpoint (Itdb_iTunesDB *itdb, const gchar *mp) * * Retrieve a reference to the mountpoint of @itdb * - * Return value: the @itdb mountpoint, this string shouldn't be freed + * Returns: the @itdb mountpoint, this string shouldn't be freed * nor modified * * Since: 0.4.0 @@ -5747,7 +5747,7 @@ const gchar *itdb_photodb_get_mountpoint (Itdb_PhotoDB *photodb) * determined number. Otherwise count the directories first and set * @itdb->musicdirs. * - * Return value: max number of directories in iPod_Control/Music + * Returns: max number of directories in iPod_Control/Music * * Since: 0.1.3 */ @@ -5779,7 +5779,7 @@ gint itdb_musicdirs_number (Itdb_iTunesDB *itdb) * itdb_cp_finalize() to obtain relevant update information for * #Itdb_Track. * - * Return value: a valid filename on the iPod where @filename can be + * Returns: a valid filename on the iPod where @filename can be * copied or NULL in case of an error. In that case @error is set * accordingly. You must free the filename when it is no longer * needed. @@ -5947,7 +5947,7 @@ gchar *itdb_cp_get_dest_filename (Itdb_Track *track, * </listitem> * </itemizedlist> * - * Return value: on success a pointer to the #Itdb_Track item passed + * Returns: on success a pointer to the #Itdb_Track item passed * or a new #Itdb_Track item if @track was NULL. In the latter case * you must free the memory using itdb_track_free() when the item is * no longer used. If an error occurs NULL is returned and @error is @@ -6083,7 +6083,7 @@ Itdb_Track *itdb_cp_finalize (Itdb_Track *track, * * @track->filetype_marker is set according to the filename extension * - * Return value: TRUE on success, FALSE on error, in which case @error is + * Returns: TRUE on success, FALSE on error, in which case @error is * set accordingly. */ gboolean itdb_cp_track_to_ipod (Itdb_Track *track, @@ -6133,7 +6133,7 @@ gboolean itdb_cp_track_to_ipod (Itdb_Track *track, * you can avoid it. * </note> * - * Return value: full filename to @track on the iPod or NULL if no + * Returns: full filename to @track on the iPod or NULL if no * filename is set in @track. Must be freed with g_free() after use. */ gchar *itdb_filename_on_ipod (Itdb_Track *track) @@ -6180,7 +6180,7 @@ gchar *itdb_filename_on_ipod (Itdb_Track *track) * * Copy file @from_file to @to_file. * - * Return value: TRUE on success, FALSE on error, in which case @error is + * Returns: TRUE on success, FALSE on error, in which case @error is * set accordingly. */ gboolean itdb_cp (const gchar *from_file, const gchar *to_file, @@ -6343,7 +6343,7 @@ itdb_file_set_contents (const char *filename, * for standard iPods and 'iTunes/iTunes_Control' for mobile * applications. * - * Return value: path to the control dir or NULL if non-existent. Must + * Returns: path to the control dir or NULL if non-existent. Must * g_free() after use. * * Since: 0.4.0 @@ -6376,7 +6376,7 @@ gchar *itdb_get_control_dir (const gchar *mountpoint) * Retrieve the directory @dir by first calling itdb_get_control_dir() * and then adding @dir * - * Return value: path to @dir or NULL if non-existent. Must g_free() + * Returns: path to @dir or NULL if non-existent. Must g_free() * after use. */ static gchar *itdb_get_dir (const gchar *mountpoint, const gchar *dir) @@ -6405,7 +6405,7 @@ static gchar *itdb_get_dir (const gchar *mountpoint, const gchar *dir) * * Retrieve a path to the @file in @dir * - * Return value: path to the @file or NULL if non-existent. Must g_free() + * Returns: path to the @file or NULL if non-existent. Must g_free() * after use. * * Since: 0.4.0 @@ -6428,7 +6428,7 @@ gchar *itdb_get_path (const gchar *dir, const gchar *file) * Retrieve the iTunes directory (containing the iTunesDB) by first * calling itdb_get_control_dir() and then adding 'iTunes' * - * Return value: path to the iTunes directory or NULL if non-existent. + * Returns: path to the iTunes directory or NULL if non-existent. * Must g_free() after use. * * Since: 0.4.0 @@ -6447,7 +6447,7 @@ gchar *itdb_get_itunes_dir (const gchar *mountpoint) * Retrieve the Music directory (containing the Fnn dirs) by first * calling itdb_get_control_dir() and then adding 'Music' * - * Return value: path to the Music directory or NULL if + * Returns: path to the Music directory or NULL if * non-existent. Must g_free() after use. */ gchar *itdb_get_music_dir (const gchar *mountpoint) @@ -6464,7 +6464,7 @@ gchar *itdb_get_music_dir (const gchar *mountpoint) * Retrieve the Device directory (containing the SysInfo file) by * first calling itdb_get_control_dir() and then adding 'Device' * - * Return value: path to the Device directory or NULL if + * Returns: path to the Device directory or NULL if * non-existent. Must g_free() after use. * * Since: 0.4.0 @@ -6483,7 +6483,7 @@ gchar *itdb_get_device_dir (const gchar *mountpoint) * Retrieve the Artwork directory (containing the ArtworDB) by * first calling itdb_get_control_dir() and then adding 'Artwork' * - * Return value: path to the Artwork directory or NULL if + * Returns: path to the Artwork directory or NULL if * non-existent. Must g_free() after use. * * Since: 0.4.0 @@ -6501,7 +6501,7 @@ gchar *itdb_get_artwork_dir (const gchar *mountpoint) * * Retrieve a path to the iTunesDB * - * Return value: path to the iTunesDB or NULL if non-existent. Must g_free() + * Returns: path to the iTunesDB or NULL if non-existent. Must g_free() * after use. * * Since: 0.4.0 @@ -6529,7 +6529,7 @@ gchar *itdb_get_itunesdb_path (const gchar *mountpoint) * * Retrieve a path to the iTunesSD * - * Return value: path to the iTunesSD or NULL if non-existent. Must g_free() + * Returns: path to the iTunesSD or NULL if non-existent. Must g_free() * after use. * * Since: 0.4.0 @@ -6557,7 +6557,7 @@ gchar *itdb_get_itunessd_path (const gchar *mountpoint) * * Retrieve a path to the ArtworkDB * - * Return value: path to the ArtworkDB or NULL if non-existent. Must g_free() + * Returns: path to the ArtworkDB or NULL if non-existent. Must g_free() * after use. * * Since: 0.4.0 @@ -6592,7 +6592,7 @@ gchar *itdb_get_artworkdb_path (const gchar *mountpoint) * Gets the current time in a format appropriate for storing in the libgpod * data structures * - * Return value: current time + * Returns: current time * * Deprecated: kept for compatibility with older code, directly use * g_get_current_time() or time(NULL) instead @@ -6612,7 +6612,7 @@ time_t itdb_time_get_mac_time (void) * * Converts a timestamp from libgpod format to host system timestamp. * - * Return value: timestamp for the host system + * Returns: timestamp for the host system * * Deprecated: It's been kept for compatibility with older code, but this * function is now a no-op @@ -6628,7 +6628,7 @@ time_t itdb_time_mac_to_host (time_t time) * * Convert host system timestamp to libgpod format timestamp * - * Return value: a libgpod timestamp + * Returns: a libgpod timestamp * * Deprecated: It's been kept for compatibility with older code, but this * function is now a no-op @@ -6651,7 +6651,7 @@ time_t itdb_time_host_to_mac (time_t time) * information as well as the directory structure required for the * type of iPod. * - * Return value: TRUE when successful, FALSE if a failure has occurred. + * Returns: TRUE when successful, FALSE if a failure has occurred. * * Since: 0.4.0 */ |