Update comments for server commands to doxygen style
This commit is contained in:
mmdolze
@@ -1,5 +1,5 @@
|
||||
/* \file server/commands/client_commands.c
|
||||
* Defines handlers for general client commands.
|
||||
/** \file server/commands/client_commands.c
|
||||
* Implements handlers for general client commands.
|
||||
*
|
||||
* This contains definitions for all the functions which clients can run.
|
||||
* The functions here are to be called only from parse.c's interpreter.
|
||||
@@ -33,7 +33,7 @@
|
||||
#include "input.h"
|
||||
|
||||
|
||||
/***************************************************************
|
||||
/**
|
||||
* Debugging only.. prints out a list of arguments it receives
|
||||
*/
|
||||
int
|
||||
@@ -48,18 +48,18 @@ test_func_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/***************************************************************
|
||||
/**
|
||||
* The client must say "hello" before doing anything else.
|
||||
*
|
||||
* It returns a string of info about the server to the client
|
||||
* It sends back a string of info about the server to the client.
|
||||
*
|
||||
* Usage: hello
|
||||
*
|
||||
* \todo Give \em real info about the server/lcd
|
||||
*/
|
||||
int
|
||||
hello_func(Client *c, int argc, char **argv)
|
||||
{
|
||||
/* TODO: Give *real* info about the server/lcd...*/
|
||||
|
||||
if (argc > 1) {
|
||||
sock_send_error(c->sock, "extra parameters ignored\n");
|
||||
}
|
||||
@@ -77,10 +77,10 @@ hello_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*****************************************************************************
|
||||
/**
|
||||
* The client should say "bye" before disconnecting
|
||||
*
|
||||
* The function does not respond to the client: it simply cuts connection
|
||||
* The function does not respond to the client: it simply cuts connection.
|
||||
*
|
||||
* Usage: bye
|
||||
*/
|
||||
@@ -96,10 +96,10 @@ bye_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/***************************************************
|
||||
* sets info about the client, such as its name
|
||||
/**
|
||||
* Sets info about the client, such as its name
|
||||
*
|
||||
* Usage: client_set -name <id>
|
||||
* Usage: client_set -name \<id\>
|
||||
*/
|
||||
int
|
||||
client_set_func(Client *c, int argc, char **argv)
|
||||
@@ -152,11 +152,11 @@ client_set_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/******************************************************************
|
||||
/**
|
||||
* Tells the server the client would like to accept keypresses
|
||||
* of a particular type
|
||||
*
|
||||
* Usage: client_add_key [-exclusively|-shared] {<key>}+
|
||||
* Usage: client_add_key [-exclusively|-shared] {\<key\>}+
|
||||
*/
|
||||
int
|
||||
client_add_key_func(Client *c, int argc, char **argv)
|
||||
@@ -195,11 +195,11 @@ client_add_key_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*********************************************************************
|
||||
/**
|
||||
* Tells the server the client would NOT like to accept keypresses
|
||||
* of a particular type
|
||||
*
|
||||
* Usage: client_del_key {<key>}+
|
||||
* Usage: client_del_key {\<key\>}+
|
||||
*/
|
||||
int
|
||||
client_del_key_func(Client *c, int argc, char **argv)
|
||||
@@ -222,7 +222,7 @@ client_del_key_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
/**
|
||||
* Toggles the backlight, if enabled.
|
||||
*
|
||||
* Usage: backlight {on|off|toggle|blink|flash}
|
||||
@@ -268,8 +268,8 @@ backlight_func(Client *c, int argc, char **argv)
|
||||
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* info_func
|
||||
/**
|
||||
* Sends back information about the loaded drivers.
|
||||
*
|
||||
* Usage: info
|
||||
*/
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
/* \file server/commands/client_commands.h
|
||||
* Declares handlers for general client commands.
|
||||
*/
|
||||
/** \file server/commands/client_commands.h */
|
||||
|
||||
/* This file is part of LCDd, the lcdproc server.
|
||||
*
|
||||
|
||||
@@ -1,11 +1,8 @@
|
||||
/* \file server/commands/command_list.c
|
||||
* Defines the dispatcher for handlers dealing with the client commands.
|
||||
/** \file server/commands/command_list.c
|
||||
* Implements the dispatcher for handlers dealing with the client commands.
|
||||
*
|
||||
* This contains definitions for all the functions which clients can run.
|
||||
* The functions here are to be called only from parse.c's interpreter.
|
||||
*
|
||||
* The client's available function set is defined here, as is the syntax
|
||||
* for each command. <-- TODO !
|
||||
*/
|
||||
|
||||
/* This file is part of LCDd, the lcdproc server.
|
||||
@@ -56,7 +53,11 @@ static client_function commands[] = {
|
||||
{ NULL, NULL},
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Looks up a function for a command sent by the client.
|
||||
* \param cmd Command to look up as string.
|
||||
* \return Pointer to the implementing function.
|
||||
*/
|
||||
CommandFunc get_command_function(char *cmd)
|
||||
{
|
||||
int i;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* \file server/commands/command_list.h
|
||||
/** \file server/commands/command_list.h
|
||||
* Declares client command dispatcher function.
|
||||
*/
|
||||
|
||||
@@ -15,16 +15,16 @@
|
||||
|
||||
#include "../client.h"
|
||||
|
||||
/*
|
||||
The function list for clients is stored in a table, and the items each
|
||||
point to a function to call, defined below.
|
||||
/**
|
||||
* The function list for clients is stored in a table, and the items each
|
||||
* point to a function to call, defined below.
|
||||
*/
|
||||
|
||||
typedef int (*CommandFunc) (Client *c, int argc, char **argv);
|
||||
|
||||
/** Defines an entry in the command table */
|
||||
typedef struct client_function {
|
||||
char *keyword;
|
||||
CommandFunc function;
|
||||
char *keyword; /**< Command string in the protocol */
|
||||
CommandFunc function; /**< Pointer to the associated function */
|
||||
} client_function;
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* \file server/commands/menu_commands.c
|
||||
* Defines handlers for client commands concerning menus.
|
||||
/** \file server/commands/menu_commands.c
|
||||
* Implements handlers for client commands concerning menus.
|
||||
*
|
||||
* This contains definitions for all the functions which clients can run.
|
||||
* The functions here are to be called only from parse.c's interpreter.
|
||||
@@ -63,14 +63,14 @@ static char *argv2string(int argc, char **argv)
|
||||
}
|
||||
|
||||
|
||||
/*************************************************************************
|
||||
* menu_add_item_func
|
||||
/**
|
||||
* Adds an item to a menu.
|
||||
*
|
||||
* Adds an item to a menu
|
||||
*
|
||||
* Usage: menu_add_item <menuid> <newitemid> <type> [<text>]
|
||||
* Usage: menu_add_item \<menuid\> \<newitemid\> \<type\> [\<text\>]
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* You (currently?) cannot create a menu in the main level yourself.
|
||||
* The names you use for items should be unique for your client.
|
||||
* The text is the visible text for the item.
|
||||
@@ -220,12 +220,11 @@ menu_add_item_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*************************************************************************
|
||||
* menu_del_item_func
|
||||
*
|
||||
/**
|
||||
* Deletes an item from a menu
|
||||
*
|
||||
* Usage: menu_del_item <menuid> <itemid>
|
||||
* Usage: menu_del_item \<menuid\> \<itemid\>
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
@@ -285,89 +284,89 @@ menu_del_item_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**************************************************************************
|
||||
* menu_set_item_func
|
||||
* Sets the info about a menu item
|
||||
/**
|
||||
* Sets the info about a menu item.
|
||||
*
|
||||
* For example, text displayed, value, etc...
|
||||
*
|
||||
* Usage: menu_set_item <menuid> <itemid> {<option>}+
|
||||
* 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:
|
||||
* -text "text" ("")
|
||||
* \li -text "text" ("")
|
||||
* Sets the visible text.
|
||||
* -is_hidden false|true (false)
|
||||
* \li -is_hidden false|true (false)
|
||||
* If the item currently should not appear in a menu.
|
||||
* -prev id ()
|
||||
* \li -prev id ()
|
||||
* Sets the predecessor of this item (what happens after "Escape")
|
||||
*
|
||||
* For all except menus:
|
||||
* -next id ()
|
||||
* \li -next id ()
|
||||
* Sets the successor of this item (what happens after "Enter")
|
||||
*
|
||||
* action:
|
||||
* -menu_result none|close|quit (none)
|
||||
* \li -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:
|
||||
* -value off|on|gray (off)
|
||||
* \li -value off|on|gray (off)
|
||||
* Sets its current value.
|
||||
* -allow_gray false|true (false)
|
||||
* \li -allow_gray false|true (false)
|
||||
* Sets if a grayed checkbox is allowed.
|
||||
*
|
||||
* ring:
|
||||
* -value <int> (0)
|
||||
* \li -value \<int\> (0)
|
||||
* Sets the index in the stringlist that is currently selected.
|
||||
* -strings <string> (empty)
|
||||
* \li -strings \<string\> (empty)
|
||||
* The subsequent strings that can be selected. They should be
|
||||
* tab-separated in ONE string.
|
||||
*
|
||||
* slider:
|
||||
* -value <int> (0)
|
||||
* \li -value \<int\> (0)
|
||||
* Sets its current value.
|
||||
* -mintext <string> ("")
|
||||
* -maxtex <string> ("")
|
||||
* \li -mintext \<string\> ("")
|
||||
* \li -maxtex \<string\> ("")
|
||||
* Text at the minimal and maximal side. On small displays these might
|
||||
* not be displayed.
|
||||
* -minvalue <int> (0)
|
||||
* -maxvalue <int> (100)
|
||||
* \li -minvalue \<int\> (0)
|
||||
* \li -maxvalue \<int\> (100)
|
||||
* The minimum and maximum value of the slider.
|
||||
* -stepsize <int> (1)
|
||||
* \li -stepsize \<int\> (1)
|
||||
* The stepsize of the slider. If you use 0, you can control it yourself
|
||||
* completely.
|
||||
*
|
||||
* numeric:
|
||||
* -value <int> (0)
|
||||
* \li -value \<int\> (0)
|
||||
* Sets its current value.
|
||||
* -minvalue <int> (0)
|
||||
* -maxvalue <int> (100)
|
||||
* \li -minvalue \<int\> (0)
|
||||
* \li -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:
|
||||
* -value <string>
|
||||
* \li -value \<string\>
|
||||
* Sets its current value. ("")
|
||||
* -password_char <char> (none)
|
||||
* -minlength <int> (0)
|
||||
* -maxlength <int> (10)
|
||||
* \li -password_char \<char\> (none)
|
||||
* \li -minlength \<int\> (0)
|
||||
* \li -maxlength \<int\> (10)
|
||||
* Set the minimum and maximum allowed length.
|
||||
* -allow_caps false|true (true)
|
||||
* -allow_noncaps false|true (false)
|
||||
* -allow_numbers false|true (true)
|
||||
* \li -allow_caps false|true (true)
|
||||
* \li -allow_noncaps false|true (false)
|
||||
* \li -allow_numbers false|true (true)
|
||||
* Allows these groups of characters.
|
||||
* -allowed_extra <string> ("")
|
||||
* \li -allowed_extra \<string\> ("")
|
||||
* The chars in this string are also allowed.
|
||||
*
|
||||
* ip:
|
||||
* -value <string>
|
||||
* \li -value \<string\>
|
||||
* Sets its current value. ("")
|
||||
* -v6 false|true
|
||||
* \li -v6 false|true
|
||||
*
|
||||
* Hmm, this is getting very big. We might need a some real parser after all.
|
||||
*/
|
||||
@@ -714,13 +713,15 @@ menu_set_item_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/***************************************************************
|
||||
* Requests the menu system to display the given menu screen. Depending on
|
||||
/**
|
||||
* Requests the menu system to display the given menu screen.
|
||||
*
|
||||
* Depending on
|
||||
* the setting of the LCDPROC_PERMISSIVE_MENU_GOTO it is impossible
|
||||
* 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>]
|
||||
* Usage: menu_goto \<id\> [\<predecessor_id\>]
|
||||
*/
|
||||
int
|
||||
menu_goto_func(Client * c, int argc, char **argv)
|
||||
@@ -759,10 +760,10 @@ menu_goto_func(Client * c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/** Sets the predecessor of a Menuitem item to itemid (for wizzards)
|
||||
* i.e. the menuitem to go to after hitting "Enter" on item.
|
||||
/** Sets the predecessor of a Menuitem item to itemid (for wizzards).
|
||||
* For example the menuitem to go to after hitting "Enter" on item.
|
||||
*
|
||||
* @return 0 on success and -1 otherwise
|
||||
* \return 0 on success and -1 otherwise
|
||||
*/
|
||||
int set_predecessor(MenuItem *item, char *itemid, Client *c)
|
||||
{
|
||||
@@ -793,13 +794,13 @@ int set_predecessor(MenuItem *item, char *itemid, Client *c)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/** Sets the successor of a Menuitem item to itemid (for wizzards) i.e. the
|
||||
/** Sets the successor of a Menuitem item to itemid (for wizzards). For example the
|
||||
* menuitem to go to after hitting "Enter" on item. Checks that a matching
|
||||
* menu item can be found. Checks if item is not a menu. (If you would
|
||||
* redefine the meaning of "Enter" for a menu it would not be useful
|
||||
* anymore.)
|
||||
*
|
||||
* @return 0 on success and -1 otherwise
|
||||
* \return 0 on success and -1 otherwise
|
||||
*/
|
||||
int set_successor(MenuItem *item, char *itemid, Client *c)
|
||||
{
|
||||
@@ -836,10 +837,10 @@ int set_successor(MenuItem *item, char *itemid, Client *c)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/***************************************************************
|
||||
/**
|
||||
* Requests the menu system to set the entry point into the menu system.
|
||||
*
|
||||
* Usage: menu_set_main <id>
|
||||
* Usage: menu_set_main \<id\>
|
||||
*/
|
||||
int
|
||||
menu_set_main_func(Client *c, int argc, char **argv)
|
||||
@@ -882,7 +883,7 @@ menu_set_main_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/***************************************************************
|
||||
/**
|
||||
* This function catches the event for the menus that have been
|
||||
* created on behalf of the clients. It informs the client with
|
||||
* an event message.
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
/* \file server/commands/menu_commands.h
|
||||
* Declares handlers for client menu commands.
|
||||
*/
|
||||
/** \file server/commands/menu_commands.h */
|
||||
|
||||
/* This file is part of LCDd, the lcdproc server.
|
||||
*
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* \file server/commands/screens_commands.c
|
||||
* Defines handlers for the client commands concerning screens.
|
||||
/** \file server/commands/screen_commands.c
|
||||
* Implements handlers for the client commands concerning screens.
|
||||
*
|
||||
* This contains definitions for all the functions which clients can run.
|
||||
* The functions here are to be called only from parse.c's interpreter.
|
||||
@@ -31,10 +31,10 @@
|
||||
#include "screen.h"
|
||||
#include "render.h"
|
||||
|
||||
/***************************************************************
|
||||
/**
|
||||
* Tells the server the client has another screen to offer
|
||||
*
|
||||
* Usage: screen_add <id>
|
||||
* Usage: screen_add \<id\>
|
||||
*/
|
||||
int
|
||||
screen_add_func(Client *c, int argc, char **argv)
|
||||
@@ -75,10 +75,10 @@ screen_add_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Client requests that the server forget about a screen
|
||||
/**
|
||||
* The client requests that the server forget about a screen
|
||||
*
|
||||
* Usage: screen_del <screenid>
|
||||
* Usage: screen_del \<screenid\>
|
||||
*/
|
||||
int
|
||||
screen_del_func(Client *c, int argc, char **argv)
|
||||
@@ -119,14 +119,14 @@ screen_del_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/***************************************************************
|
||||
/**
|
||||
* 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>]
|
||||
* 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\>]
|
||||
*/
|
||||
int
|
||||
screen_set_func(Client *c, int argc, char **argv)
|
||||
@@ -409,11 +409,11 @@ screen_set_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**********************************************************************
|
||||
/**
|
||||
* 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>
|
||||
* Usage: screen_add_key \<screenid\> \<keylist\>
|
||||
*/
|
||||
int
|
||||
screen_add_key_func(Client *c, int argc, char **argv)
|
||||
@@ -485,11 +485,11 @@ screen_add_key_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*************************************************************************
|
||||
/**
|
||||
* 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>
|
||||
* Usage: screen_del_key \<screenid\> \<keylist\>
|
||||
*/
|
||||
int
|
||||
screen_del_key_func(Client *c, int argc, char **argv)
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
/* \file server/commands/screen_commands.h
|
||||
* Declares handlers for client screen commands.
|
||||
*/
|
||||
/** \file server/commands/screen_commands.h */
|
||||
|
||||
/* This file is part of LCDd, the lcdproc server.
|
||||
*
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* \file server/commands/server_commands.c
|
||||
* Defines handlers for client commands concerning the server settings.
|
||||
/** \file server/commands/server_commands.c
|
||||
* Implements handlers for client commands concerning the server settings.
|
||||
*
|
||||
* This contains definitions for all the functions which clients can run.
|
||||
* The functions here are to be called only from parse.c's interpreter.
|
||||
@@ -30,14 +30,14 @@
|
||||
#include "client.h"
|
||||
#include "render.h"
|
||||
|
||||
/****************************************************************************
|
||||
* Sets the state of the output port (such as on MtxOrb LCDs)
|
||||
*
|
||||
* Usage: output <on|off|int>
|
||||
*/
|
||||
#define ALL_OUTPUTS_ON -1
|
||||
#define ALL_OUTPUTS_OFF 0
|
||||
|
||||
/**
|
||||
* Sets the state of the output port (such as on MtxOrb LCDs)
|
||||
*
|
||||
* Usage: output \<on|off|int\>
|
||||
*/
|
||||
int
|
||||
output_func(Client *c, int argc, char **argv)
|
||||
{
|
||||
@@ -93,10 +93,12 @@ output_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* sleep_func
|
||||
/**
|
||||
* The sleep_func was intended to make the server sleep for some seconds.
|
||||
* This function is currently ignored as making the server sleep actually
|
||||
* stalls it and disrupts other clients.
|
||||
*
|
||||
* Usage: sleep <seconds>
|
||||
* Usage: sleep \<seconds\>
|
||||
*/
|
||||
int
|
||||
sleep_func(Client *c, int argc, char **argv)
|
||||
@@ -158,8 +160,8 @@ sleep_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*****************************************************************************
|
||||
* Does nothing, returns "noop complete" message
|
||||
/**
|
||||
* Does nothing, returns "noop complete" message.
|
||||
*
|
||||
* This is useful for shell scripts or programs that want to talk
|
||||
* with LCDproc and not get deadlocked. Send a noop after each
|
||||
@@ -174,4 +176,3 @@ noop_func(Client *c, int argc, char **argv)
|
||||
sock_send_string(c->sock, "noop complete\n");
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
/* \file server/commands/server_commands.h
|
||||
* Declares handlers for client commands dealing with server properties.
|
||||
*/
|
||||
/** \file server/commands/server_commands.h */
|
||||
|
||||
/* This file is part of LCDd, the lcdproc server.
|
||||
*
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* \file server/commands/widget_commands.c
|
||||
* Defines handlers for client commands concerning widgets.
|
||||
/** \file server/commands/widget_commands.c
|
||||
* Implements handlers for client commands concerning widgets.
|
||||
*
|
||||
* This contains definitions for all the functions which clients can run.
|
||||
* The functions here are to be called only from parse.c's interpreter.
|
||||
@@ -34,10 +34,10 @@
|
||||
#include "drivers.h"
|
||||
|
||||
|
||||
/*************************************************************************
|
||||
/**
|
||||
* Adds a widget to a screen, but doesn't give it a value
|
||||
*
|
||||
* Usage: widget_add <screenid> <widgetid> <widgettype> [-in <id>]
|
||||
* Usage: widget_add \<screenid\> \<widgetid\> \<widgettype\> [-in \<id\>]
|
||||
*/
|
||||
int
|
||||
widget_add_func(Client *c, int argc, char **argv)
|
||||
@@ -120,10 +120,10 @@ widget_add_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*******************************************************************
|
||||
/**
|
||||
* Removes a widget from a screen, and forgets about it
|
||||
*
|
||||
* Usage: widget_del <screenid> <widgetid>
|
||||
* Usage: widget_del \<screenid\> \<widgetid\>
|
||||
*/
|
||||
int
|
||||
widget_del_func(Client *c, int argc, char **argv)
|
||||
@@ -169,13 +169,11 @@ widget_del_func(Client *c, int argc, char **argv)
|
||||
return 0;
|
||||
}
|
||||
|
||||
/********************************************************************
|
||||
/**
|
||||
* Configures information about a widget, such as its size, shape,
|
||||
* contents, position, speed, etc...
|
||||
* contents, position, speed, etc.
|
||||
*
|
||||
* Ack! This is long!
|
||||
*
|
||||
* widget_set <screenid> <widgetid> <widget-SPECIFIC-data>
|
||||
* widget_set \<screenid\> \<widgetid\> \<widget-SPECIFIC-data\>
|
||||
*/
|
||||
int
|
||||
widget_set_func(Client *c, int argc, char **argv)
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
/* \file server/commands/widget_commands.h
|
||||
* Declares handlers for client widget commands.
|
||||
*/
|
||||
/** \file server/commands/widget_commands.h */
|
||||
|
||||
/* This file is part of LCDd, the lcdproc server.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user