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

add Doxygen comments

Browse Source
This commit is contained in:
marschap
2008-11-30 12:01:53 +00:00
parent b3a7841e2e
commit d6ac9b559d
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/client.h
+15 -15
View File
@@ -1,6 +1,8 @@
/* /** \file client.h
* client.h * Defines all the client data and actions.
* This file is part of LCDd, the lcdproc server. */
/* This file is part of LCDd, the lcdproc server.
* *
* This file is released under the GNU General Public License. Refer to the * This file is released under the GNU General Public License. Refer to the
* COPYING file distributed with this package. * COPYING file distributed with this package.
@@ -8,7 +10,6 @@
* Copyright (c) 1999, William Ferrell, Scott Scriven * Copyright (c) 1999, William Ferrell, Scott Scriven
* 2002, Joris Robijn * 2002, Joris Robijn
* *
* Defines all the client data and actions.
*/ */
#include "menu.h" #include "menu.h"
@@ -23,12 +24,15 @@
#define CLIENT_NAME_SIZE 256 #define CLIENT_NAME_SIZE 256
/** Possible states of a client. */
typedef enum _clientstate { typedef enum _clientstate {
NEW, NEW, /**< Client did not yet send \c hello. */
ACTIVE, ACTIVE, /**< Client sent \c hello, but not yet \c bye. */
GONE GONE /**< Client sent \c bye. */
} ClientState; } ClientState;
/** The structure representing a client in the server. */
typedef struct Client { typedef struct Client {
char *name; char *name;
ClientState state; ClientState state;
@@ -36,17 +40,13 @@ typedef struct Client {
int backlight; int backlight;
int heartbeat; int heartbeat;
/* Messages that the client generated */ LinkedList *messages; /**< Messages that the client sent. */
LinkedList *messages; LinkedList *screenlist; /**< List of client's screens. */
/* The list of screens */
LinkedList *screenlist;
/* Maybe it has created a menu */
Menu *menu;
Menu *menu; /**< Menu hierarchy, if any */
} Client; } Client;
#include "screen.h" #include "screen.h"
/* When a new client connects, set up a new client data struct */ /* When a new client connects, set up a new client data struct */