Diff: FrenchTime.h

Revision:

3:3b689218225e

Parent:

0:2ef6fb83757c

Child:

4:3fdbc10667a6

--- a/FrenchTime.h	Wed May 04 13:58:14 2016 +0000
+++ b/FrenchTime.h	Fri May 06 12:09:02 2016 +0000
@@ -33,6 +33,11 @@
      * @returns
      *  uint8_t 1 (hiver)
      *  uint8_t 2 (été)
+     *
+     *@code
+     *int DecalageHoraire = frenchTimeOffset(29,10,2016); //return 1
+     *int DecalageHoraire = frenchTimeOffset(30,10,2016); //return 2
+     *@endcode
      */
     static uint8_t frenchTimeOffset(uint8_t day, uint8_t month, int year);
 
@@ -42,6 +47,10 @@
      * @param month mois
      * @param year année
      * @return uin8_t jour du mois de 1 à 31
+     *
+     *@code
+     *int dateDuDernierDimancheDuMois = lastSundayOfMonth(5,2016); //return 29
+     *@endcode
      */
     static uint8_t lastSundayOfMonth(uint8_t month, int year);
 
@@ -52,6 +61,10 @@
      * @param month mois
      * @param year année
      * @return uin8_t jour de la semaine de 0(dimanche) à 6(samedi)
+     *
+     *@code
+     *int jour = lastSundayOfMonth(22,6,2016); //return 3
+     *@endcode
      */
     static uint8_t dayOfWeek(uint8_t day, uint8_t month, int year);
 };