summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars-Dominik Braun <PromyLOPh@gmail.com>2008-06-12 20:55:24 +0200
committerLars-Dominik Braun <PromyLOPh@gmail.com>2008-06-12 20:55:24 +0200
commitc17e785395246007a177b69347213384094befc5 (patch)
tree67d6f6d3c476bca1c3de02ae5ba025f7a95638fa
parentfd978b5fa3ad57813c39d831d2bb7c4751d2adfd (diff)
downloadpianobar-windows-c17e785395246007a177b69347213384094befc5.tar.gz
pianobar-windows-c17e785395246007a177b69347213384094befc5.tar.bz2
pianobar-windows-c17e785395246007a177b69347213384094befc5.zip
lib: Misc documentation fixes
-rw-r--r--libpiano/main.c6
-rw-r--r--libpiano/xml.c12
2 files changed, 12 insertions, 6 deletions
diff --git a/libpiano/main.c b/libpiano/main.c
index 4d186a9..3e77490 100644
--- a/libpiano/main.c
+++ b/libpiano/main.c
@@ -168,7 +168,6 @@ void PianoDestroy (PianoHandle_t *ph) {
* @return nothing
*/
void PianoConnect (PianoHandle_t *ph, char *user, char *password) {
- /* sync */
char url[PIANO_URL_BUFFER_SIZE];
char *requestStr = PianoEncryptString ("<?xml version=\"1.0\"?>"
"<methodCall><methodName>misc.sync</methodName>"
@@ -415,8 +414,9 @@ PianoReturn_t PianoDeleteStation (PianoHandle_t *ph, PianoStation_t *station) {
return ret;
}
-/* search for music (artist or track), needed to create new station, don't
- * forget to free the search result
+/* search for music (artist or track), needed to create new station; don't
+ * forget to free the search result; beware! searchResult will be nulled
+ * by PianoXmlParseSearch
* @author PromyLOPh
* @added 2008-06-11
* @public yes
diff --git a/libpiano/xml.c b/libpiano/xml.c
index 3862cb5..de3f150 100644
--- a/libpiano/xml.c
+++ b/libpiano/xml.c
@@ -246,6 +246,12 @@ void PianoXmlParseStations (PianoHandle_t *ph, char *xml) {
xmlCleanupParser();
}
+/* parses playlist; used when searching too
+ * @author PromyLOPh
+ * @added 2008-06-12
+ * @param piano handle
+ * @param xml document
+ */
void PianoXmlParsePlaylist (PianoHandle_t *ph, char *xml) {
/* FIXME: copy & waste */
xmlNode *docRoot = NULL, *curNode = NULL;
@@ -339,7 +345,7 @@ void PianoXmlParseSearchArtistCb (char *key, xmlNode *value, void *data) {
}
/* callback for xml struct parser used in PianoXmlParseSearch, "switch" for
- * PianoXmlParseSearchArtistCb and XXX
+ * PianoXmlParseSearchArtistCb and PianoXmlParsePlaylistCb
* @author PromyLOPh
* @added 2008-06-12
*/
@@ -399,7 +405,7 @@ void PianoXmlParseSearchCb (char *key, xmlNode *value, void *data) {
}
}
-/* parse search result
+/* parse search result; searchResult is nulled before use
* @author PromyLOPh
* @added 2008-06-12
* @param xml document
@@ -428,7 +434,7 @@ void PianoXmlParseSearch (char *searchXml,
xmlCleanupParser();
}
-/* encode reserved chars
+/* encode reserved xml chars
* @author PromyLOPh
* @added 2008-06-10
* @param encode this