don't mark inline the functions that are exported

[simgrid.git] / src / surf / maxmin_private.hpp

diff --git a/src/surf/maxmin_private.hpp b/src/surf/maxmin_private.hpp
index f7f75c0..bccc217 100644 (file)
--- a/src/surf/maxmin_private.hpp
+++ b/src/surf/maxmin_private.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2012. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -7,11 +7,16 @@
 #ifndef _SURF_MAXMIN_PRIVATE_H
 #define _SURF_MAXMIN_PRIVATE_H
 
+#include <xbt/base.h>
+
 #include "surf/maxmin.h"
 #include "xbt/swag.h"
 #include "xbt/mallocator.h"
 #include "surf_interface.hpp"
 
+/** @ingroup SURF_lmm
+ * @brief LMM element
+ */
 typedef struct lmm_element {
   /* hookup to constraint */
   s_xbt_swag_hookup_t element_set_hookup;
@@ -29,6 +34,9 @@ typedef struct lmm_constraint_light {
   lmm_constraint_t cnst;
 } s_lmm_constraint_light_t;
 
+/** @ingroup SURF_lmm
+ * @brief LMM constraint
+ */
 typedef struct lmm_constraint {
   /* hookup to system */
   s_xbt_swag_hookup_t constraint_set_hookup;
@@ -41,7 +49,7 @@ typedef struct lmm_constraint {
   double remaining;
   double usage;
   double bound;
-  int shared;
+  int sharing_policy; /* see @e_surf_link_sharing_policy_t (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
   void *id;
   int id_int;
   double lambda;
@@ -49,6 +57,9 @@ typedef struct lmm_constraint {
   lmm_constraint_light_t cnst_light;
 } s_lmm_constraint_t;
 
+/** @ingroup SURF_lmm
+ * @brief LMM variable
+ */
 typedef struct lmm_variable {
   /* hookup to system */
   s_xbt_swag_hookup_t variable_set_hookup;
@@ -72,6 +83,9 @@ typedef struct lmm_variable {
   /* \end{For Lagrange only} */
 } s_lmm_variable_t;
 
+/** @ingroup SURF_lmm
+ * @brief LMM system
+ */
 typedef struct lmm_system {
   int modified;
   int selective_update_active;  /* flag to update partially the system only selecting changed portions */
@@ -85,7 +99,7 @@ typedef struct lmm_system {
   s_xbt_swag_t saturated_variable_set;  /* a list of lmm_variable_t */
   s_xbt_swag_t saturated_constraint_set;        /* a list of lmm_constraint_t_t */
 
-  ActionLmmListPtr keep_track;
+  simgrid::surf::ActionLmmListPtr keep_track;
 
   xbt_mallocator_t variable_mallocator;
 } s_lmm_system_t;
@@ -102,10 +116,15 @@ typedef struct lmm_system {
   do { xbt_swag_remove(cnst, &sys->active_constraint_set);              \
     xbt_swag_remove(cnst, &sys->modified_constraint_set); } while (0)
 
-void lmm_print(lmm_system_t sys);
+/** @ingroup SURF_lmm
+ * @brief Print informations about a lmm system
+ * 
+ * @param sys A lmm system
+ */
+XBT_PRIVATE void lmm_print(lmm_system_t sys);
 
-extern double (*func_f_def) (lmm_variable_t, double);
-extern double (*func_fp_def) (lmm_variable_t, double);
-extern double (*func_fpi_def) (lmm_variable_t, double);
+extern XBT_PRIVATE double (*func_f_def) (lmm_variable_t, double);
+extern XBT_PRIVATE double (*func_fp_def) (lmm_variable_t, double);
+extern XBT_PRIVATE double (*func_fpi_def) (lmm_variable_t, double);
 
 #endif                          /* _SURF_MAXMIN_PRIVATE_H */