Fix a typo in the comment and add a (somewhat vague) description of the values returned.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20492 a1c6a512-1295-4272-9138-f99709370657

1 files changed, 8 insertions, 4 deletions

diff --git a/apps/gui/gwps-common.h b/apps/gui/gwps-common.h
index 8752c1d162..0d196b28e4 100644
--- a/apps/gui/gwps-common.h
+++ b/apps/gui/gwps-common.h
@@ -28,21 +28,25 @@
 /* fades the volume, e.g. on pause or stop */
 void fade(bool fade_in, bool updatewps);
 
-/* Initially display the wps, can fall back to the build-in wps
- * if the chosen wps is invalid */
+/* Initially display the wps, can fall back to the built-in wps
+ * if the chosen wps is invalid.
+ *
+ * Return true on success, otherwise false */
 bool gui_wps_display(struct gui_wps *gui_wps);
 
 /* return true if screen restore is needed
    return false otherwise */
 bool update_onvol_change(struct gui_wps * gwps);
 
-/* Update track info related stuff, handles cue sheets as well, and redraw */
+/* Update track info related stuff, handle cue sheets as well, and redraw */
 bool gui_wps_update(struct gui_wps *gwps);
 
 bool ffwd_rew(int button);
 void display_keylock_text(bool locked);
 
-/* Refresh the WPS according to refresh_mode. */
+/* Refresh the WPS according to refresh_mode.
+ *
+ * Return true on success, otherwise false */
 bool gui_wps_redraw(struct gui_wps *gwps,
                      int ffwd_offset,
                      unsigned refresh_mode);