mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Partly revert previous commit. The doxygen style escape sequences look

Browse Source 
nice on the web, but make the source comments really hard to read.
Therefore copy the command descriptions preformatted to html.
This commit is contained in:
mmdolze
2009-05-14 18:13:29 +00:00
parent 9f09507e0a
commit 54a8a63112
5 changed files with 93 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/commands/client_commands.c
+17 -3
View File
@@ -53,7 +53,9 @@ test_func_func(Client *c, int argc, char **argv)
*
* It sends back a string of info about the server to the client.
*
*\verbatim
* Usage: hello
*\endverbatim
*
* \todo Give \em real info about the server/lcd
*/
@@ -82,7 +84,9 @@ hello_func(Client *c, int argc, char **argv)
*
* The function does not respond to the client: it simply cuts connection.
*
*\verbatim
* Usage: bye
*\endverbatim
*/
int
bye_func(Client *c, int argc, char **argv)
@@ -99,7 +103,9 @@ bye_func(Client *c, int argc, char **argv)
/**
* Sets info about the client, such as its name
*
* Usage: client_set -name \<id\>
*\verbatim
* Usage: client_set -name <id>
*\endverbatim
*/
int
client_set_func(Client *c, int argc, char **argv)
@@ -156,7 +162,9 @@ client_set_func(Client *c, int argc, char **argv)
* Tells the server the client would like to accept keypresses
* of a particular type
*
* Usage: client_add_key [-exclusively|-shared] {\<key\>}+
*\verbatim
* Usage: client_add_key [-exclusively|-shared] {<key>}+
*\endverbatim
*/
int
client_add_key_func(Client *c, int argc, char **argv)
@@ -199,7 +207,9 @@ client_add_key_func(Client *c, int argc, char **argv)
* Tells the server the client would NOT like to accept keypresses
* of a particular type
*
* Usage: client_del_key {\<key\>}+
*\verbatim
* Usage: client_del_key {<key>}+
*\endverbatim
*/
int
client_del_key_func(Client *c, int argc, char **argv)
@@ -225,7 +235,9 @@ client_del_key_func(Client *c, int argc, char **argv)
/**
* Toggles the backlight, if enabled.
*
*\verbatim
* Usage: backlight {on|off|toggle|blink|flash}
*\endverbatim
*/
int
backlight_func(Client *c, int argc, char **argv)
@@ -271,7 +283,9 @@ backlight_func(Client *c, int argc, char **argv)
/**
* Sends back information about the loaded drivers.
*
*\verbatim
* Usage: info
*\endverbatim
*/
int
info_func(Client *c, int argc, char **argv)
server/commands/menu_commands.c
+43 -33
View File
@@ -66,7 +66,9 @@ static char *argv2string(int argc, char **argv)
/**
* Adds an item to a menu.
*
* Usage: menu_add_item \<menuid\> \<newitemid\> \<type\> [\<text\>]
*\verbatim
* Usage: menu_add_item <menuid> <newitemid> <type> [<text>]
*\endverbatim
*
* You should use "" as id for the client's main menu. This menu will be
* created automatically when you add an item to it the first time.
@@ -223,7 +225,9 @@ menu_add_item_func(Client *c, int argc, char **argv)
/**
* Deletes an item from a menu
*
* Usage: menu_del_item \<menuid\> \<itemid\>
*\verbatim
* Usage: menu_del_item <menuid> <itemid>
*\endverbatim
*
* The given item in the given menu will be deleted. If you have deleted all
* the items from your client menu, that menu will automatically be removed.
@@ -289,84 +293,86 @@ menu_del_item_func(Client *c, int argc, char **argv)
*
* For example, text displayed, value, etc...
*
* Usage: menu_set_item \<menuid\> \<itemid\> {\<option\>}+
*\verbatim
* Usage: menu_set_item <menuid> <itemid> {<option>}+
*
* The following parameters can be set per item:
* (you should include the - in the option)
*
* For all types:
* \li -text "text" ("")
* -text "text" ("")
* Sets the visible text.
* \li -is_hidden false|true (false)
* -is_hidden false|true (false)
* If the item currently should not appear in a menu.
* \li -prev id ()
* -prev id ()
* Sets the predecessor of this item (what happens after "Escape")
*
* For all except menus:
* \li -next id ()
* -next id ()
* Sets the successor of this item (what happens after "Enter")
*
* action:
* \li -menu_result none|close|quit (none)
* -menu_result none|close|quit (none)
* Sets what to do with the menu when this action is selected:
* - none: the menu stays as it is.
* - close: the menu closes and returns to a higher level.
* - quit: quits the menu completely so you can foreground your app.
*
* checkbox:
* \li -value off|on|gray (off)
* -value off|on|gray (off)
* Sets its current value.
* \li -allow_gray false|true (false)
* -allow_gray false|true (false)
* Sets if a grayed checkbox is allowed.
*
* ring:
* \li -value \<int\> (0)
* -value <int> (0)
* Sets the index in the stringlist that is currently selected.
* \li -strings \<string\> (empty)
* -strings <string> (empty)
* The subsequent strings that can be selected. They should be
* tab-separated in ONE string.
*
* slider:
* \li -value \<int\> (0)
* -value <int> (0)
* Sets its current value.
* \li -mintext \<string\> ("")
* \li -maxtex \<string\> ("")
* -mintext <string> ("")
* -maxtex <string> ("")
* Text at the minimal and maximal side. On small displays these might
* not be displayed.
* \li -minvalue \<int\> (0)
* \li -maxvalue \<int\> (100)
* -minvalue <int> (0)
* -maxvalue <int> (100)
* The minimum and maximum value of the slider.
* \li -stepsize \<int\> (1)
* -stepsize <int> (1)
* The stepsize of the slider. If you use 0, you can control it yourself
* completely.
*
* numeric:
* \li -value \<int\> (0)
* -value <int> (0)
* Sets its current value.
* \li -minvalue \<int\> (0)
* \li -maxvalue \<int\> (100)
* -minvalue <int> (0)
* -maxvalue <int> (100)
* The minimum and maximum value that are allowed. If you make one of
* them negative, the user will be able to enter negative numbers too.
* Maybe floats will work too in the future.
*
* alpha:
* \li -value \<string\>
* -value <string>
* Sets its current value. ("")
* \li -password_char \<char\> (none)
* \li -minlength \<int\> (0)
* \li -maxlength \<int\> (10)
* -password_char <char> (none)
* -minlength <int> (0)
* -maxlength <int> (10)
* Set the minimum and maximum allowed length.
* \li -allow_caps false|true (true)
* \li -allow_noncaps false|true (false)
* \li -allow_numbers false|true (true)
* -allow_caps false|true (true)
* -allow_noncaps false|true (false)
* -allow_numbers false|true (true)
* Allows these groups of characters.
* \li -allowed_extra \<string\> ("")
* -allowed_extra <string> ("")
* The chars in this string are also allowed.
*
* ip:
* \li -value \<string\>
* -value <string>
* Sets its current value. ("")
* \li -v6 false|true
* -v6 false|true
*\endverbatim
*
* Hmm, this is getting very big. We might need a some real parser after all.
*/
@@ -721,7 +727,9 @@ menu_set_item_func(Client *c, int argc, char **argv)
* to go to a menu of another client (or the server menus). Same
* restriction applies to the optional predecessor_id
*
* Usage: menu_goto \<id\> [\<predecessor_id\>]
*\verbatim
* Usage: menu_goto <id> [<predecessor_id>]
*\endverbatim
*/
int
menu_goto_func(Client * c, int argc, char **argv)
@@ -840,7 +848,9 @@ int set_successor(MenuItem *item, char *itemid, Client *c)
/**
* Requests the menu system to set the entry point into the menu system.
*
* Usage: menu_set_main \<id\>
*\verbatim
* Usage: menu_set_main <id>
*\endverbatim
*/
int
menu_set_main_func(Client *c, int argc, char **argv)
server/commands/screen_commands.c
+18 -8
View File
@@ -34,7 +34,9 @@
/**
* Tells the server the client has another screen to offer
*
* Usage: screen_add \<id\>
*\verbatim
* Usage: screen_add <id>
*\endverbatim
*/
int
screen_add_func(Client *c, int argc, char **argv)
@@ -78,7 +80,9 @@ screen_add_func(Client *c, int argc, char **argv)
/**
* The client requests that the server forget about a screen
*
* Usage: screen_del \<screenid\>
*\verbatim
* Usage: screen_del <screenid>
*\endverbatim
*/
int
screen_del_func(Client *c, int argc, char **argv)
@@ -123,10 +127,12 @@ screen_del_func(Client *c, int argc, char **argv)
* Configures info about a particular screen, such as its
* name, priority, or duration
*
* Usage: screen_set \<id\> [-name \<name\>] [-wid \<width\>] [-hgt \<height\>]
* [-priority \<prio\>] [-duration \<int\>] [-timeout \<int\>]
* [-heartbeat \<type\>] [-backlight \<type\>]
* [-cursor \<type\>] [-cursor_x \<xpos\>] [-cursor_y \<ypos\>]
*\verbatim
* Usage: screen_set <id> [-name <name>] [-wid <width>] [-hgt <height>]
* [-priority <prio>] [-duration <int>] [-timeout <int>]
* [-heartbeat <type>] [-backlight <type>]
* [-cursor <type>] [-cursor_x <xpos>] [-cursor_y <ypos>]
*\endverbatim
*/
int
screen_set_func(Client *c, int argc, char **argv)
@@ -413,7 +419,9 @@ screen_set_func(Client *c, int argc, char **argv)
* Tells the server the client would like to accept keypresses
* of a particular type when the given screen is active on the display
*
* Usage: screen_add_key \<screenid\> \<keylist\>
*\verbatim
* Usage: screen_add_key <screenid> <keylist>
*\endverbatim
*/
int
screen_add_key_func(Client *c, int argc, char **argv)
@@ -489,7 +497,9 @@ screen_add_key_func(Client *c, int argc, char **argv)
* Tells the server the client would NOT like to accept keypresses
* of a particular type when the given screen is active on the display
*
* Usage: screen_del_key \<screenid\> \<keylist\>
*\verbatim
* Usage: screen_del_key <screenid> <keylist>
*\endverbatim
*/
int
screen_del_key_func(Client *c, int argc, char **argv)
server/commands/server_commands.c
+6 -2
View File
@@ -36,7 +36,9 @@
/**
* Sets the state of the output port (such as on MtxOrb LCDs)
*
* Usage: output \<on|off|int\>
*\verbatim
* Usage: output <on|off|int>
*\endverbatim
*/
int
output_func(Client *c, int argc, char **argv)
@@ -98,7 +100,9 @@ output_func(Client *c, int argc, char **argv)
* This function is currently ignored as making the server sleep actually
* stalls it and disrupts other clients.
*
* Usage: sleep \<seconds\>
*\verbatim
* Usage: sleep <seconds>
*\endverbatim
*/
int
sleep_func(Client *c, int argc, char **argv)
server/commands/widget_commands.c
+9 -3
View File
@@ -37,7 +37,9 @@
/**
* Adds a widget to a screen, but doesn't give it a value
*
* Usage: widget_add \<screenid\> \<widgetid\> \<widgettype\> [-in \<id\>]
*\verbatim
* Usage: widget_add <screenid> <widgetid> <widgettype> [-in <id>]
*\endverbatim
*/
int
widget_add_func(Client *c, int argc, char **argv)
@@ -123,7 +125,9 @@ widget_add_func(Client *c, int argc, char **argv)
/**
* Removes a widget from a screen, and forgets about it
*
* Usage: widget_del \<screenid\> \<widgetid\>
*\verbatim
* Usage: widget_del <screenid> <widgetid>
*\endverbatim
*/
int
widget_del_func(Client *c, int argc, char **argv)
@@ -173,7 +177,9 @@ widget_del_func(Client *c, int argc, char **argv)
* Configures information about a widget, such as its size, shape,
* contents, position, speed, etc.
*
* widget_set \<screenid\> \<widgetid\> \<widget-SPECIFIC-data\>
*\verbatim
* widget_set <screenid> <widgetid> <widget-SPECIFIC-data>
*\endverbatim
*/
int
widget_set_func(Client *c, int argc, char **argv)