piano: Describe narrative functions added in last commit

2 files changed, 12 insertions, 0 deletions

diff --git a/libpiano/src/main.c b/libpiano/src/main.c
index 2b51303..dbc273b 100644
--- a/libpiano/src/main.c
+++ b/libpiano/src/main.c
@@ -779,6 +779,12 @@ PianoReturn_t PianoTransformShared (PianoHandle_t *ph,
 	return ret;
 }
 
+/*	"why dit you play this song?"
+ *	@param piano handle
+ *	@param song (from playlist)
+ *	@param return allocated string; you have to free it yourself
+ *	@return _OK or error
+ */
 PianoReturn_t PianoExplain (const PianoHandle_t *ph, const PianoSong_t *song,
 		char **retExplain) {
 	char xmlSendBuf[PIANO_SEND_BUFFER_SIZE], url[PIANO_URL_BUFFER_SIZE];
diff --git a/libpiano/src/xml.c b/libpiano/src/xml.c
index 6d4dad8..4d945e7 100644
--- a/libpiano/src/xml.c
+++ b/libpiano/src/xml.c
@@ -745,6 +745,11 @@ PianoReturn_t PianoXmlParseTranformStation (const char *searchXml) {
 	return PIANO_RET_OK;
 }
 
+/*	parses "why did you play ...?" answer
+ *	@param xml
+ *	@param returns the answer
+ *	@return _OK or error
+ */
 PianoReturn_t PianoXmlParseNarrative (const char *xml, char **retNarrative) {
 	xmlNode *docRoot;
 	xmlDocPtr doc;
@@ -754,6 +759,7 @@ PianoReturn_t PianoXmlParseNarrative (const char *xml, char **retNarrative) {
 		return ret;
 	}
 
+	/* <methodResponse> <params> <param> <value> $textnode */
 	xmlNode *val = docRoot->children->children->children->children;
 	*retNarrative = strdup ((char *) val->content);