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

Add more documentation to lcd_lib, lcterm and pylcd driver

Browse Source 
Refactor todo entries in the documentation and add them to the TODO file
Document some known bugs and remove some that are known to be fixed.
This commit is contained in:
mmdolze
2009-03-22 11:11:18 +00:00
parent 92185c9ea0
commit 15f2bf4ba3
5 changed files with 61 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/drivers/lcd_lib.c
+20 -20
View File
@@ -1,3 +1,13 @@
/** \file server/drivers/lcd_lib.c
* LCD library of useful functions for drivers.
*
* Drawn from the "base driver" which really was the precursor
* to this library.
*
* \todo Make use of the \c options parameter to specify SEAMLESS_HBARS,
* the height of hbars, etc.
*/
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
@@ -8,26 +18,16 @@
# include "config.h"
#endif
// ==================================================
// LCD library of useful functions for drivers
// ==================================================
// Drawn from the "base driver" which really was the precursor
// to this library....
// TODO: What should this really be? Probably should be in the
// driver code or headers or something...
void
lib_hbar_static (Driver *drvthis, int x, int y, int len, int promille, int options, int cellwidth, int cc_offset)
/*
/**
* This function places a hbar using the v0.5 API format and the given cellwidth.
* It assumes that custom chars have been statically defined, so that number
* 1 has 1 pixel, number 2 has 2 etc...
* 1 has 1 pixel, number 2 has 2 etc.
*
* LCDs that have the custom chars at other char numbers than 0 should put the
* first custom char number in cc_offset.
*/
void
lib_hbar_static (Driver *drvthis, int x, int y, int len, int promille, int options, int cellwidth, int cc_offset)
{
int total_pixels = ((long) 2 * len * cellwidth + 1 ) * promille / 2000;
int pos;
@@ -55,16 +55,16 @@ lib_hbar_static (Driver *drvthis, int x, int y, int len, int promille, int optio
}
}
void
lib_vbar_static (Driver *drvthis, int x, int y, int len, int promille, int options, int cellheight, int cc_offset)
/*
/**
* This function places a vbar using the v0.5 API format and the given cellwidth.
* It assumes that custom chars have been statically defined, so that number
* 1 has 1 pixel, number 2 has 2 etc., just like in good old times...
* 1 has 1 pixel, number 2 has 2 etc., just like in good old times.
*
* LCDs that have the custom chars at other char numbers than 0 should put the
* first custom char number in cc_offset.
*/
void
lib_vbar_static (Driver *drvthis, int x, int y, int len, int promille, int options, int cellheight, int cc_offset)
{
int total_pixels = ((long) 2 * len * cellheight + 1 ) * promille / 2000;
int pos;