a little bit of Doxygen ...
This commit is contained in:
+15
-13
@@ -1,6 +1,8 @@
|
|||||||
/*
|
/** \file clients/lcdexec/menu.h
|
||||||
* lcdexec/menu.h
|
* Declare constants, data types and functions for menu functions in clients/lcdexec/menu.c.
|
||||||
* This file is part of lcdexec, an LCDproc client.
|
*/
|
||||||
|
|
||||||
|
/* This file is part of lcdexec, an LCDproc client.
|
||||||
*
|
*
|
||||||
* 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.
|
||||||
@@ -22,24 +24,24 @@
|
|||||||
|
|
||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
unknown = 0,
|
unknown = 0, /**< unknown menu entry. */
|
||||||
menu = 1,
|
menu = 1, /**< menu entry representing a menu. */
|
||||||
exec = 2,
|
exec = 2, /**< menu entry repesenting a command. */
|
||||||
} MenuType;
|
} MenuType;
|
||||||
|
|
||||||
|
|
||||||
typedef struct menu_entry {
|
typedef struct menu_entry {
|
||||||
char *name;
|
char *name; /**< Name of the menu entry. */
|
||||||
char *displayname;
|
char *displayname; /**< Display name of the enty. */
|
||||||
int id;
|
int id; /**< Internal ID of the entry. */
|
||||||
MenuType type;
|
MenuType type; /**< Type of the entry. */
|
||||||
|
|
||||||
// variables necessary for type menu
|
// variables necessary for type menu
|
||||||
struct menu_entry *entries;
|
struct menu_entry *entries; /**< Subordinate menu entries (for MenuType menu). */
|
||||||
struct menu_entry *next;
|
struct menu_entry *next; /**< Next sibling menu entry (for MenuType menu). */
|
||||||
|
|
||||||
// variables necessary for type exec
|
// variables necessary for type exec
|
||||||
char *command;
|
char *command; /**< Command to execute (for MenuType exec). */
|
||||||
} MenuEntry;
|
} MenuEntry;
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
/** \file serverscreens.h
|
/** \file serverscreens.h
|
||||||
* Interface for the serverscreen implementation
|
* Interface for the serverscreen implementation.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
@@ -18,9 +18,9 @@
|
|||||||
#include "screen.h"
|
#include "screen.h"
|
||||||
|
|
||||||
/* server screen rotation states */
|
/* server screen rotation states */
|
||||||
#define SERVERSCREEN_OFF 0 /* show server screen in rotation */
|
#define SERVERSCREEN_OFF 0 /**< Show server screen in rotation. */
|
||||||
#define SERVERSCREEN_ON 1 /* show server sreen only when there is no other screen */
|
#define SERVERSCREEN_ON 1 /**< Show server sreen only when there is no other screen. */
|
||||||
#define SERVERSCREEN_BLANK 2 /* don't rotate, and only show a blank screen [not implemented] */
|
#define SERVERSCREEN_BLANK 2 /**< Don't rotate, and only show a blank screen. */
|
||||||
|
|
||||||
extern Screen *server_screen;
|
extern Screen *server_screen;
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user