Add note that alternate 'play icons' use two characters.

2011-02-10 22:57:47 +00:00
parent baae2e1958
commit b36789fe10
1 changed files with 3 additions and 0 deletions
@@ -580,6 +580,9 @@ driver_alt_heartbeat(Driver *drv, int state)
 * \param x     Horizontal character position (column).
 * \param y     Vertical character position (row).
 * \param icon  synbolic value representing the icon.
+ *
+ * \note Icons used for 'play control' actually are composed of two
+ *       characters. Drivers must check for bounds on calls to chr()!
 */
 void
 driver_alt_icon(Driver *drv, int x, int y, int icon)