Update doxygen doc for lcdexec and lcdvc.
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/* \file clients/lcdexec/lcdexec.c
|
||||
* Main file for \lcdexec, the program starter in the LCDproc suite.
|
||||
/** \file clients/lcdexec/lcdexec.c
|
||||
* Main file for \c lcdexec, the program starter in the LCDproc suite.
|
||||
*/
|
||||
|
||||
/* This file is part of lcdexec, an LCDproc client.
|
||||
|
||||
@@ -28,7 +28,7 @@ static char *boolValueName[] = { "false", "true" };
|
||||
static char *triGrayValueName[] = { "off", "on", "gray" };
|
||||
|
||||
|
||||
/* recursively read the menu hierarchy */
|
||||
/** recursively read the menu hierarchy */
|
||||
MenuEntry *menu_read(MenuEntry *parent, const char *name)
|
||||
{
|
||||
static int id = 0;
|
||||
@@ -243,7 +243,7 @@ MenuEntry *menu_read(MenuEntry *parent, const char *name)
|
||||
}
|
||||
|
||||
|
||||
/* create LCDproc commands for the menu entry hierarchy and send it to the server */
|
||||
/** create LCDproc commands for the menu entry hierarchy and send it to the server */
|
||||
int menu_sock_send(MenuEntry *me, MenuEntry *parent, int sock)
|
||||
{
|
||||
if ((me != NULL) && (sock > 0)) {
|
||||
@@ -422,7 +422,7 @@ int menu_sock_send(MenuEntry *me, MenuEntry *parent, int sock)
|
||||
}
|
||||
|
||||
|
||||
/* find menu entry by its id */
|
||||
/** find menu entry by its id */
|
||||
MenuEntry *menu_find_by_id(MenuEntry *me, int id)
|
||||
{
|
||||
if (me != NULL) {
|
||||
@@ -444,7 +444,7 @@ MenuEntry *menu_find_by_id(MenuEntry *me, int id)
|
||||
}
|
||||
|
||||
|
||||
/* return command of a menu entry */
|
||||
/** return command of a menu entry */
|
||||
const char *menu_command(MenuEntry *me)
|
||||
{
|
||||
if ((me != NULL) && (me->type == MT_EXEC))
|
||||
@@ -454,7 +454,7 @@ const char *menu_command(MenuEntry *me)
|
||||
}
|
||||
|
||||
|
||||
/* free menu entry hierarchy */
|
||||
/** free menu entry hierarchy */
|
||||
void menu_free(MenuEntry *me)
|
||||
{
|
||||
if (me != NULL) {
|
||||
@@ -536,7 +536,7 @@ void menu_free(MenuEntry *me)
|
||||
|
||||
|
||||
#if defined(DEBUG)
|
||||
/* dump menu entry hierarchy to screen */
|
||||
/** dump menu entry hierarchy to screen */
|
||||
void menu_dump(MenuEntry *me)
|
||||
{
|
||||
if (me != NULL) {
|
||||
|
||||
@@ -1,3 +1,17 @@
|
||||
/** \file clients/lcdvc/lcd_link.c
|
||||
* Functions to build and update the display and to handle server input.
|
||||
*/
|
||||
|
||||
/*-
|
||||
* This file is part of lcdvc, an LCDproc client.
|
||||
*
|
||||
* This file is released under the GNU General Public License. Refer to the
|
||||
* COPYING file distributed with this package.
|
||||
*
|
||||
* Copyright (c) 2002, Joris Robijn
|
||||
* 2006-2008, Peter Marschall
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <unistd.h>
|
||||
#include <string.h>
|
||||
@@ -135,14 +149,15 @@ static int read_connect_string(void)
|
||||
}
|
||||
|
||||
|
||||
static int split(char *str, char delim, char *parts[], int maxparts)
|
||||
/* Splits a string into parts, to which pointers will be returned in &parts.
|
||||
/**
|
||||
* Splits a string into parts, to which pointers will be returned in &parts.
|
||||
* The return value is the number of parts.
|
||||
* maxparts is the maximum number of parts returned. If more parts exist
|
||||
* they are (unsplit) in the last part.
|
||||
* The parts are split at the character delim.
|
||||
* No new space will be allocated, the string str will be mutated !
|
||||
*/
|
||||
static int split(char *str, char delim, char *parts[], int maxparts)
|
||||
{
|
||||
char *p1 = str;
|
||||
char *p2;
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
/*
|
||||
* lcdvc.c
|
||||
/** \file clients/lcdvc/lcdvc.c
|
||||
* Main file for \c lcdvc, the LCDproc virtual console.
|
||||
*/
|
||||
|
||||
/*-
|
||||
* This file is part of lcdvc, an LCDproc client.
|
||||
*
|
||||
* This file is released under the GNU General Public License. Refer to the
|
||||
|
||||
@@ -1,3 +1,17 @@
|
||||
/** \file clients/lcdvc/vc_link.c
|
||||
* Functions to handle a virtual console.
|
||||
*/
|
||||
|
||||
/*-
|
||||
* This file is part of lcdvc, an LCDproc client.
|
||||
*
|
||||
* This file is released under the GNU General Public License. Refer to the
|
||||
* COPYING file distributed with this package.
|
||||
*
|
||||
* Copyright (c) 2002, Joris Robijn
|
||||
* 2006-2008, Peter Marschall
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <unistd.h>
|
||||
#include <string.h>
|
||||
|
||||
Reference in New Issue
Block a user