Exclude file with Qt-style documentation.
[bertos.git] / drv / lcd_text.h
index 1a0ecae3d2063ba64518b96200af0bafc6e50831..4f138471d1bdac5915bd6a7ef193b78e10784f4f 100755 (executable)
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
 
 /*#*
  *#* $Log$
+ *#* Revision 1.3  2006/07/19 12:56:26  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.2  2006/02/23 10:59:14  bernie
+ *#* Documentation fixes.
+ *#*
  *#* Revision 1.1  2005/11/04 18:00:42  bernie
  *#* Import into DevLib.
  *#*
@@ -51,7 +57,7 @@
 #define LCD_CENTER     BV(1)   /* Center string in line */
 #define LCD_NOCURSOR   BV(2)   /* Scrittura senza spostamento cursore */
 
-/*! Special priority value for lcd_setLayerDepth(). */
+/** Special priority value for lcd_setLayerDepth(). */
 #define LAYER_HIDDEN   -128
 
 /* Compute LCD address from x/y coordinates */
 #define LCD_ROW2  (LCD_COLS * 2)
 #define LCD_ROW3  (LCD_COLS * 3)
 
-/*!
+/**
  * Overwrapping layer context.
  */
 typedef struct _Layer
 {
-       /*!
+       /**
         * Active layers are linked together in a list
         * sorted in top to bottom order.
         */
        DECLARE_NODE_ANON(struct _Layer)
 
-       /*! Current XY address into this layer, for write operations. */
+       /** Current XY address into this layer, for write operations. */
        lcdpos_t addr;
 
-       /*! Priority of this layer (greater in front of lesser). */
+       /** Priority of this layer (greater in front of lesser). */
        char pri;
 
-       /*!
-        * Buffer per il salvataggio ed il ripristino del
-        * contenuto del display. Le posizioni che contengono
-        * il carattere '\0' sono trasparenti.
+       /**
+        * Layer backing store buffer.
+        *
+        * All writes through the layer are copied into this buffer.
+        * Characters cells with value 0 are transparent with respect
+        * to other layers in the background.
         */
        char buf[LCD_COLS * LCD_ROWS];
 } Layer;