Update of /cvsroot/gtkpod/libgpod/src
In directory sc8-pr-cvs2.sourceforge.net:/tmp/cvs-serv22787/src
Modified Files:
itdb.h itdb_photoalbum.c
Log Message:
Add PhotoDB functions to the docs.
Incorporate usage overviews from README into the docs.
Fix a few doc comments to allow gtk-doc to parse them.
Index: itdb.h
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/src/itdb.h,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -d -r1.56 -r1.57
--- itdb.h 10 Jan 2007 13:25:10 -0000 1.56
+++ itdb.h 11 Jan 2007 07:10:55 -0000 1.57
@@ -1033,7 +1033,7 @@
gint pos);
Itdb_PhotoDB *itdb_photodb_create (const gchar *mountpoint);
void itdb_photodb_free (Itdb_PhotoDB *photodb);
-gboolean itdb_photodb_write (Itdb_PhotoDB *db, GError **error);
+gboolean itdb_photodb_write (Itdb_PhotoDB *photodb, GError **error);
void itdb_photodb_remove_photo (Itdb_PhotoDB *db,
Itdb_PhotoAlbum *album,
Itdb_Artwork *photo);
Index: itdb_photoalbum.c
===================================================================
RCS file: /cvsroot/gtkpod/libgpod/src/itdb_photoalbum.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- itdb_photoalbum.c 10 Jan 2007 13:25:10 -0000 1.14
+++ itdb_photoalbum.c 11 Jan 2007 07:10:55 -0000 1.15
@@ -51,7 +51,7 @@
memory). It is automatically added to the Photo Library Album
(first album), which is created if it does not exist already.
- itdb_photodb_photoalbum_craete():
+ itdb_photodb_photoalbum_create():
Create and add a new photoalbum.
itdb_photodb_photoalbum_add_photo():
@@ -198,12 +198,11 @@
/**
* itdb_photodb_parse:
- *
- * Parses the photo database of an iPod mounted at @mp.
- *
* @mp: mountpoint of the iPod
* @error: will contain the error description when an error occured.
*
+ * Parses the photo database of an iPod mounted at @mp.
+ *
* Return value: the imported PhotoDB or NULL in case of an error.
**/
Itdb_PhotoDB *itdb_photodb_parse (const gchar *mp, GError **error)
@@ -229,7 +228,6 @@
/**
* itdb_photodb_create:
- *
* @mountpoint: mountpoint or NULL.
*
* Creates a new Itdb_PhotoDB. If mountpoint is NULL, you will have to
@@ -582,6 +580,9 @@
* @albumname: the name of the photoalbum to get or NULL for the
* master photoalbum.
*
+ * Find the first photoalbum with a given name or the Photo Library
+ * Album if called with no name.
+ *
* Return value: a pointer to the first photoalbum named @albumname,
* else NULL
*/
@@ -603,7 +604,7 @@
}
/**
- * itdb_photodb_remove_photoalbum:
+ * itdb_photodb_photoalbum_remove:
* @db: the #Itdb_PhotoDB to apply changes to
* @album: the album to be removed from the database
* @remove_pics: TRUE to remove pics in that album permanently from
@@ -670,10 +671,12 @@
/**
* itdb_photodb_photoalbum_create:
* @db: The database to create a new album in
- * @album_name: the name of the new album
+ * @albumname: the name of the new album
* @pos: position where to insert the newly created album (-1 for
* append to end).
*
+ * Create and add a new photoalbum.
+ *
* Return value: the album which was created and added.
*/
Itdb_PhotoAlbum *itdb_photodb_photoalbum_create (Itdb_PhotoDB *db,
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
gtkpod-cvs2 mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gtkpod-cvs2
