Diff: Lcd.h

Revision:

2:bcb0d1541b67

Parent:

1:ab21ec2e6cf5

Child:

3:f5877d3dcc0f

--- a/Lcd.h	Fri Jun 02 10:17:46 2017 +0000
+++ b/Lcd.h	Fri Jun 02 10:31:17 2017 +0000
@@ -1,6 +1,7 @@
 #ifndef MBED_LCD_H
 #define MBED_LCD_H
-/** Classe Lcd, utilisée par l'IOGS pour afficher des informations sur l'ecran.
+/** Classe Lcd.
+ *  Utilisée par l'IOGS pour afficher des informations sur l'ecran.
  *
  * Example:
  * @code
@@ -23,7 +24,7 @@
  
 class Lcd {
 public:
-        /** Déclare un écran LCD
+    /** Déclare un écran LCD
          *
          * @param rs Broche de la carte Nucleo L476RG reliée à la broche rs du LCD
          * @param sck Broche de la carte Nucleo L476RG reliée à la broche sck du LCD
@@ -34,14 +35,26 @@
     Lcd(PinName rs, PinName sck, PinName miso, PinName mosi,PinName cs);
         /** Fonction d'initialisation de l'écran LCD
          * @note l'appel de cette fonction est essentiel pour afficher quelque chose sur le LCD
-         * @code
          */
     void init_LCD(void);
-
+        /** Affiche un caractère sur l'écran LCD
+         *
+         * @param c le caractère à afficher
+         * @returns rien
+         */
     void write_LCD(char c);
-
+        /** Affiche une chaine de caractères sur l'écran LCD
+         *
+         * @param c tableau de caractères (ou string).
+         * @note il est essentiel que la chaine de caractères se termine par \0.
+         * @param ligne numero de la ligne du premier caractère (entre 1 et 3)
+         * @param colonne numero de la colonne du premier caractère (entre 1 et 16)
+         * @returns rien
+         */
     void writeStr_LCD(char c[], char ligne, char colonne);
-
+        /** Efface ce qu'il y a affiché sur l'écran LCD
+         */
+    void clear_LCD(void);
     
 private:
     DigitalOut RS_LCD;