Project

General

Profile

Revision 891

Moved comments to headers. That was painful.

View differences:

lcd.h
38 38
#define _LCD_H_
39 39

  
40 40
/**
41
 * @addtogroup lcd
41
 * @defgroup lcd LCD
42
 * @brief Functions for the LCD
43
 * Functions for writing to the LCD.
44
 * All functions may be found in lcd.h.
45
 *
42 46
 * @{
43 47
 **/
44 48

  
45
/** @brief Initialize the LCD screen **/
49
/**
50
 * @brief Initialize the LCD screen
51
 * Initializes the LCD. Must be called before any other
52
 * LCD functions.
53
 **/
46 54
void lcd_init(void);
47
/** @brief Clear the LCD screen **/
55

  
56
/**
57
 * @brief Clear the LCD screen
58
 *
59
 * Clears the LCD screen. lcd_init must be called first.
60
 * 
61
 * @see lcd_init
62
 **/
48 63
void lcd_clear_screen( void );
49
/** @brief Print a char to the LCD screen **/
64

  
65
/**
66
 * @brief Print a char to the LCD screen
67
 *
68
 * Prints a character on the LCD screen. lcd_init
69
 * must be called before this function may be used.
70
 *
71
 * @param c the character to print
72
 *
73
 * @see lcd_init
74
 **/
50 75
void lcd_putc(char c);
51
/** @brief Print a string to the LCD screen **/
76

  
77
/**
78
 * @brief Print a string to the LCD screen
79
 * 
80
 * Print a string to the LCD screen.
81
 *
82
 * @param s the string to print
83
 **/
52 84
void lcd_puts(char *s);
53
/** @brief Print an int to the LCD screen **/
85

  
86
/**
87
 * @brief Print an int to the LCD screen
88
 *
89
 * Print an integer to the LCD screen.
90
 * lcd_init must be called before this function may be used.
91
 * 
92
 * @param value the integer to print
93
 *
94
 * @see lcd_init
95
 **/
54 96
void lcd_puti(int value);
55
/** @brief Set the current cursor position **/
97

  
98
/**
99
 * @brief Set the current cursor position
100
 *
101
 * Move the current cursor position to the one specified.
102
 * lcd_init must be called before this function may be used.
103
 * 
104
 * @param x The x coordinate of the new position
105
 * @param y The y coordinate of the new position
106
 *
107
 * @see lcd_init
108
 **/
56 109
void lcd_gotoxy(int x, int y);
57 110

  
58 111
/** @} **/

Also available in: Unified diff