Doxygen-ize

2008-12-21 12:57:46 +00:00
parent c9e3db4a8d
commit 065fb021fe
3 changed files with 46 additions and 37 deletions
@@ -1,16 +1,17 @@
 #ifndef LCD_IRMANIN__H
 #define LCD_IRMANIN_H

+/** mapping between IrMan code names and LCDd key names */
 typedef struct _codemap {
-	const char *irman;
-	const char *lcdproc;
+	const char *irman;	/**< IrMan code name */
+	const char *lcdproc;	/**< LCDpüroc key name */
 } CodeMap;

 /** private data for the \c irman driver */
 typedef struct irmanin_private_data {
-	char device[256];
-	char config[256];
-	char *portname;
+	char device[256];	/**< IrMan device name */
+	char config[256];	/**< IrMan config file */
+	char *portname;		/**< IrMan port name */
 } PrivateData;

 MODULE_EXPORT int irmanin_init (Driver *drvthis);