Changeset 2808 in Sophya for trunk/SophyaLib/NTools/datime.h

Timestamp:

Jun 14, 2005, 1:25:05 PM (20 years ago)

Author:

ansari

Message:

MAJ documentation - Reza 14/6/2005

File:

• trunk/SophyaLib/NTools/datime.h (modified) (5 diffs)

trunk/SophyaLib/NTools/datime.h

@@ -10 +10 @@
 
 
+/*! 
+  \ingroup NTools
+  \file datime.h
+  Set of C functions and macros to manipulate date and time + Sidereal time.
+  \sa datime.c
+  \warning : If possible, use class SOPHYA::TimeStamp
+*/
+/*! 
+  \ingroup NTools
+  \brief Structure JMA pour representer une date (Jour, Mois Annee) */
 typedef struct 
   {
@@ -17 +27 @@
   }  JMA ;
 
-
+/*! 
+  \ingroup NTools
+  \brief Structure HMS pour representer une heure (Heure, Minute Seconde) 
+*/
 typedef struct 
   {
@@ -25 +38 @@
   } HMS ;
 
+/* \cond
 /*   ----------    2) Donnees constantes  ---------- */
 #ifdef  DATIMEPRIVEE
@@ -43 +57 @@
 #endif
 
+/* \endcond */
 /*    ------ 3) Macro de manipulation de date et heure  -------  */
-
 #define  NomJour(d)      (NomJo[NumJour(d)-1])
 #define  NomMois(d)      (NomMo[d.Mois-1])
 
-/*   Chaine de forme  hh:mm:sec  <->  structure HMS   */
+/*        Chaine de forme  hh:mm:sec  <->  structure HMS   */
+/*! \brief  Decodage de Chaine de forme  hh:mm:sec   ->  structure HMS   */
 #define  StrgtoHMS(s,h)  ( sscanf(s,"%d:%d:%lf", &(h.Heures),&(h.Minutes),&(h.Secondes)) )
+/*! \brief  structure HMS -> Chaine de forme  hh:mm:sec  */
 #define  HMStoStrg(h,s)  ( sprintf(s,"%02d:%02d:%02.0f", h.Heures,h.Minutes,h.Secondes) )
 
@@ -55 +71 @@
 /* EA 140998, machin infame pour que ca marche pour 1998/09/14... Pourquoi avoir fait */
 /* des macros ??????????????????????????????????????????????????????????????????????? */
+/*!  \brief Chaine de caracteres sous forme de dd/mm/aaaa -> structure JMA jma. */
 #define  StrgtoJMA(strg,j)  ( sscanf(strg,"%d/%d/%d", &(j.Jour),&(j.Mois),&(j.Annee)),\
     (j.Jour>1900 ? sscanf(strg,"%d/%d/%d", &(j.Annee),&(j.Mois),&(j.Jour)) : 1) ) 
-
+/*! \brief structure JMA -> Chaine de forme jj/mm/aa       */
 #define  JMAtoStrg(j,strg)  ( sprintf(strg,"%02d/%02d/%4d", j.Jour,j.Mois,j.Annee) )
+/*! \brief structure JMA -> Chaine de forme jj/mm/aa       */
 #define  JMAtoStrgLong(j,strg)   ( sprintf(strg,"%s , %d %s %d", NomJo[NumJour(j)-1], j.Jour, NomMo[j.Mois-1], j.Annee) )