Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
uniformize gras_os_sleep prototype (seconds are double everywhere else, avoid roundin...
[simgrid.git] / include / gras / virtu.h
index c3a50d9..e8c5fae 100644 (file)
@@ -1,8 +1,8 @@
-/* $Id$                     */
+/* $Id$                    */
 
 /* gras/virtu.h - public interface to virtualization (cross-OS portability) */
 
-/* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
+/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "xbt/misc.h" /* BEGIN_DECL */
 
-BEGIN_DECL
+BEGIN_DECL()
 
-/**
- * gras_os_time:
- * @Returns: number of second since the Epoch.
- * (00:00:00 UTC, January 1, 1970 in Real Life, and begining of simulation in SG)
- * 
- * Get the current time.
+/** @addtogroup GRAS_virtu  
+ *  @brief System call abstraction layer (Virtualization).
+ *  @{
+ */
+
+/** @brief Get the current time
+ *  @return number of second since the Epoch.
+ *  (00:00:00 UTC, January 1, 1970 in Real Life, and begining of simulation in SG)
  */
 double gras_os_time(void);
 
-/**
- * gras_os_sleep:
- * @Param1: number of seconds to sleep
- * @Param2: number of microseconds to sleep
- * 
- * sleeps for the given amount of time.
+/** @brief sleeps for the given amount of time.
+ *  @param sec: number of seconds to sleep
  */
-void gras_os_sleep(unsigned long sec, unsigned long usec);
+void gras_os_sleep(double sec);
 
-/**
- * gras_get_my_fqdn:
+/** @brief get the fully-qualified name of the current host
  *
  * Returns the fully-qualified name of the host machine, or NULL if the name
  * cannot be determined.  Always returns the same value, so multiple calls
@@ -42,7 +39,8 @@ void gras_os_sleep(unsigned long sec, unsigned long usec);
 const char *
 gras_get_my_fqdn(void);
 
-END_DECL
+/** @} */
+END_DECL()
 
 #endif /* GRAS_VIRTU_H */