summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTodd Zullinger <tmz@pobox.com>2008-08-05 01:22:10 -0400
committerTodd Zullinger <tmz@pobox.com>2008-11-14 12:14:43 -0500
commit7916fcf8acae19550f6d28b7877a124b075ec83e (patch)
treeafb011520a9479163479bbfcc6bdab71665525e9
parent4d2fe3aaf416ecef682130a0a6d0c89a29cd15af (diff)
downloadlibgpod-7916fcf8acae19550f6d28b7877a124b075ec83e.tar.gz
libgpod-7916fcf8acae19550f6d28b7877a124b075ec83e.tar.xz
libgpod-7916fcf8acae19550f6d28b7877a124b075ec83e.zip
Documentation: mark functions added in 0.5.0
-rw-r--r--src/itdb.h26
-rw-r--r--src/itdb_device.c4
-rw-r--r--src/itdb_itunesdb.c8
-rw-r--r--src/itdb_photoalbum.c4
-rw-r--r--src/itdb_track.c4
5 files changed, 42 insertions, 4 deletions
diff --git a/src/itdb.h b/src/itdb.h
index 5c4c6c7..5563fe3 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -276,6 +276,8 @@ struct _Itdb_IpodInfo {
* ITDB_SPL_STRING_MAXLEN:
*
* Maximum string length for smart playlists
+ *
+ * Since: 0.5.0
*/
#define ITDB_SPL_STRING_MAXLEN 255
@@ -283,6 +285,8 @@ struct _Itdb_IpodInfo {
* ITDB_SPL_DATE_IDENTIFIER:
*
* Identifier for smart playlist date fields
+ *
+ * Since: 0.5.0
*/
#define ITDB_SPL_DATE_IDENTIFIER (G_GINT64_CONSTANT (0x2dae2dae2dae2daeU))
@@ -310,6 +314,8 @@ typedef enum {
* @ITDB_LIMITTYPE_GB: Limit in gigabytes
*
* The type of unit to use when limiting a playlist
+ *
+ * Since: 0.5.0
*/
typedef enum {
ITDB_LIMITTYPE_MINUTES = 0x01,
@@ -349,6 +355,8 @@ typedef enum {
* That way, we don't have to deal with programs using the class needing to set
* the wrong limit and then make it into the "opposite", which would be frickin'
* annoying.
+ *
+ * Since: 0.5.0
*/
typedef enum {
ITDB_LIMITSORT_RANDOM = 0x02,
@@ -410,6 +418,8 @@ typedef enum {
* bit 9 = "in the last"
* </programlisting>
* </informalexample>
+ *
+ * Since: 0.5.0
*/
typedef enum {
ITDB_SPLACTION_IS_INT = 0x00000001,
@@ -447,6 +457,8 @@ typedef enum {
* @ITDB_SPLFT_BINARY_AND: binary AND
*
* Smart Playlist Field Types
+ *
+ * Since: 0.5.0
*/
typedef enum
{
@@ -474,6 +486,8 @@ typedef enum
* @ITDB_SPLAT_BINARY_AND: is / is not (binary AND)
*
* Smart Playlist Action Types
+ *
+ * Since: 0.5.0
*/
typedef enum
{
@@ -500,6 +514,8 @@ typedef enum
* These are to pass to AddRule() when you need a unit for the two "in the last"
* action types. In theory, you can use any time range. iTunes might not
* like it, but the iPod shouldn't care.
+ *
+ * Since: 0.5.0
*/
typedef enum {
ITDB_SPLACTION_LAST_DAYS_VALUE = 86400, /* nr of secs in 24 hours */
@@ -572,6 +588,8 @@ typedef enum {
* @ITDB_SPLFIELD_ALBUMARTIST: Album artist (string)
*
* Smart Playlist Fields, used for Smart Playlist Rules (#Itdb_SPLRule).
+ *
+ * Since: 0.5.0
*/
typedef enum {
ITDB_SPLFIELD_SONG_NAME = 0x02,
@@ -621,6 +639,8 @@ typedef enum {
*
* Smart Playlist preferences are for various flags that are not strictly smart
* playlist "rules."
+ *
+ * Since: 0.5.0
*/
struct _Itdb_SPLPref
{
@@ -670,6 +690,8 @@ struct _Itdb_SPLPref
*
* For more details see <ulink
* url="http://ipodlinux.org/ITunesDB.html&num;Smart_Playlist_Rule_Values">ipodlinux.org</ulink>.
+ *
+ * Since: 0.5.0
*/
struct _Itdb_SPLRule
{
@@ -706,6 +728,8 @@ struct _Itdb_SPLRule
* @reserved2: Reserved for future use
*
* Smart Playlist Rules
+ *
+ * Since: 0.5.0
*/
struct _Itdb_SPLRules
{
@@ -1134,6 +1158,8 @@ typedef enum
* The mediatype is used to determine what menu a track appears under. For
* example, setting the mediatype to #ITDB_MEDIATYPE_PODCAST makes the track
* appear on the Podcast menu.
+ *
+ * Since: 0.5.0
*/
typedef enum
{
diff --git a/src/itdb_device.c b/src/itdb_device.c
index ff2500a..79ecd01 100644
--- a/src/itdb_device.c
+++ b/src/itdb_device.c
@@ -1340,6 +1340,8 @@ const gchar *itdb_info_get_ipod_generation_string (Itdb_IpodGeneration generatio
* iPod so you can spare calls to the artwork handling methods.
*
* Return value: true if @device can display artwork.
+ *
+ * Since: 0.5.0
*/
gboolean itdb_device_supports_artwork (const Itdb_Device *device)
{
@@ -1408,6 +1410,8 @@ gboolean itdb_device_supports_video (const Itdb_Device *device)
* Indicates whether @device can display photos or not.
*
* Return value: true if @device can display photos.
+ *
+ * Since: 0.5.0
*/
gboolean itdb_device_supports_photo (const Itdb_Device *device)
{
diff --git a/src/itdb_itunesdb.c b/src/itdb_itunesdb.c
index 5d662b3..e98e507 100644
--- a/src/itdb_itunesdb.c
+++ b/src/itdb_itunesdb.c
@@ -5778,7 +5778,9 @@ gint itdb_musicdirs_number (Itdb_iTunesDB *itdb)
* 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.
- **/
+ *
+ * Since: 0.5.0
+ */
gchar *itdb_cp_get_dest_filename (Itdb_Track *track,
const gchar *mountpoint,
const gchar *filename,
@@ -5935,7 +5937,9 @@ gchar *itdb_cp_get_dest_filename (Itdb_Track *track,
* no longer used. If an error occurs NULL is returned and @error is
* set accordingly. Errors occur when @dest_filename cannot be
* accessed or the mountpoint is not set.
- **/
+ *
+ * Since: 0.5.0
+ */
Itdb_Track *itdb_cp_finalize (Itdb_Track *track,
const gchar *mountpoint,
const gchar *dest_filename,
diff --git a/src/itdb_photoalbum.c b/src/itdb_photoalbum.c
index 2e6168b..276ae8b 100644
--- a/src/itdb_photoalbum.c
+++ b/src/itdb_photoalbum.c
@@ -547,7 +547,9 @@ Itdb_Artwork *itdb_photodb_add_photo_from_data (Itdb_PhotoDB *db,
* ..._CLOCKWISE.
*
* Return value: a pointer to the added photo.
- **/
+ *
+ * Since: 0.5.0
+ */
Itdb_Artwork *itdb_photodb_add_photo_from_pixbuf (Itdb_PhotoDB *db,
gpointer pixbuf,
gint position,
diff --git a/src/itdb_track.c b/src/itdb_track.c
index 4053a93..9b1fefa 100644
--- a/src/itdb_track.c
+++ b/src/itdb_track.c
@@ -487,7 +487,9 @@ gboolean itdb_track_set_thumbnails_from_data (Itdb_Track *track,
* similar function is called.
*
* Return value: TRUE if the thumbnail could be added, FALSE otherwise.
- **/
+ *
+ * Since: 0.5.0
+ */
gboolean itdb_track_set_thumbnails_from_pixbuf (Itdb_Track *track,
gpointer pixbuf)
{