Cleanup and documentation updates:

- Remove shared/str.h where not used.
- Remove shared/debug.h from all files as it has been completely replaced
  by shared/report.h (it will be removed later).
- Add more doxygen comments to shared/* and clients/lcdproc/*.
- Include static functions in doxygen output.
This commit is contained in:
mmdolze committed 2010-02-02 23:20:29 +00:00
1 parent e914ee3d72
commit 66023939a1
49 files changed
+929 -590

No files matched your search

+19 -28
View File
@@ -1,51 +1,42 @@
#ifndef IFACE_H
#define IFACE_H
/* netlcdclient.h - definitions and function prototipes
*
/** \file clients/lcdproc/iface.h
* Definitions and function prototypes for \c iface.c.
* Imported from \c netlcdclient.h.
*/
/*-
* Copyright (C) 2002 Luis Llorente Campo
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*/
#include <time.h>
#include "machine.h"
#ifndef IFACE_H
#define IFACE_H
#define MAX_INTERFACES 3 /* max number of interfaces in multi-interface mode */
int iface_screen(int rep, int display, int *flags_ptr);
IfaceInfo iface[MAX_INTERFACES]; /* interface info */
/************************/
/* Functions prototipes */
/************************/
/* read interface stats from /proc/net/dev */
/** Update screen content */
int iface_screen(int rep, int display, int *flags_ptr);
/** read interface stats from /proc/net/dev */
int get_iface_stats(IfaceInfo *interface);
/* send initial commands to server to add the speed screen */
/** send initial commands to server to add the speed screen */
void initialize_speed_screen(void);
/* send initial commands to server to add the transfer screen */
/** send initial commands to server to add the transfer screen */
void initialize_transfer_screen(void);
/* format the time in ASCII */
/** format the time in ASCII */
void get_time_string(char *buff, time_t last_online);
/* format value, scaling value and adding proper suffixes */
/** format value, scaling value and adding proper suffixes */
void format_value(char *buff, double value, char *unit);
/* format value, scaling value and adding proper suffixes (for multi-interface
/** format value, scaling value and adding proper suffixes (for multi-interface
* mode) */
void format_value_multi_interface(char *buff, double value, char *unit);
/* actualize widgets values in speed screen */
/** actualize widgets values in speed screen */
void actualize_speed_screen(IfaceInfo *iface, unsigned int interval, int index);
/* actualize widgets values in transfer screen */
/** actualize widgets values in transfer screen */
void actualize_transfer_screen(IfaceInfo *iface, int index);
#endif