diff options
author | Fabian Oehlmann <oehlmann@in.tum.de> | 2013-10-18 16:07:57 +0000 |
---|---|---|
committer | Fabian Oehlmann <oehlmann@in.tum.de> | 2013-10-18 16:07:57 +0000 |
commit | fee2937fbd13db0107f187f36bd1e6203f560127 (patch) | |
tree | d712ca6b65b15b8bf3846d15e3a2092db639d018 /src | |
parent | f38103524a5e65207ae029f7de0b880c6072e19f (diff) | |
download | gnunet-fee2937fbd13db0107f187f36bd1e6203f560127.tar.gz gnunet-fee2937fbd13db0107f187f36bd1e6203f560127.zip |
fix documentation errors
Diffstat (limited to 'src')
-rwxr-xr-x | src/ats/libgnunet_plugin_ats_ril.c | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/src/ats/libgnunet_plugin_ats_ril.c b/src/ats/libgnunet_plugin_ats_ril.c index 641ed5266..62292ba0d 100755 --- a/src/ats/libgnunet_plugin_ats_ril.c +++ b/src/ats/libgnunet_plugin_ats_ril.c | |||
@@ -588,8 +588,8 @@ envi_set_active_suggestion (struct GAS_RIL_Handle *solver, | |||
588 | 588 | ||
589 | /** | 589 | /** |
590 | * Allocates a state vector and fills it with the features present | 590 | * Allocates a state vector and fills it with the features present |
591 | * | ||
592 | * @param solver the solver handle | 591 | * @param solver the solver handle |
592 | * @param agent the agent handle | ||
593 | * @return pointer to the state vector | 593 | * @return pointer to the state vector |
594 | */ | 594 | */ |
595 | static double * | 595 | static double * |
@@ -633,7 +633,6 @@ envi_get_state (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent) | |||
633 | * For all networks a peer has an address in, this gets the maximum bandwidth which could | 633 | * For all networks a peer has an address in, this gets the maximum bandwidth which could |
634 | * theoretically be available in one of the networks. This is used for bandwidth normalization. | 634 | * theoretically be available in one of the networks. This is used for bandwidth normalization. |
635 | * | 635 | * |
636 | * @param solver the solver handle | ||
637 | * @param agent the agent handle | 636 | * @param agent the agent handle |
638 | * @param direction_in whether the inbound bandwidth should be considered. Returns the maximum outbound bandwidth if GNUNET_NO | 637 | * @param direction_in whether the inbound bandwidth should be considered. Returns the maximum outbound bandwidth if GNUNET_NO |
639 | */ | 638 | */ |
@@ -744,7 +743,8 @@ envi_reward_local (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent) | |||
744 | * parts from the local (the peer specific) and the global (for all peers | 743 | * parts from the local (the peer specific) and the global (for all peers |
745 | * identical) reward. | 744 | * identical) reward. |
746 | * | 745 | * |
747 | * @param solver solver handle | 746 | * @param solver the solver handle |
747 | * @param agent the agent handle | ||
748 | * @return the reward | 748 | * @return the reward |
749 | */ | 749 | */ |
750 | static double | 750 | static double |
@@ -916,8 +916,9 @@ envi_action_address_switch (struct GAS_RIL_Handle *solver, | |||
916 | /** | 916 | /** |
917 | * Puts the action into effect by calling the according function | 917 | * Puts the action into effect by calling the according function |
918 | * | 918 | * |
919 | * @param solver solver handle | 919 | * @param solver the solver handle |
920 | * @param action action to perform by the solver | 920 | * @param agent the action handle |
921 | * @param action the action to perform by the solver | ||
921 | */ | 922 | */ |
922 | static void | 923 | static void |
923 | envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action) | 924 | envi_do_action (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent, int action) |
@@ -1045,8 +1046,8 @@ agent_step (struct RIL_Peer_Agent *agent) | |||
1045 | /** | 1046 | /** |
1046 | * Cycles through all agents and lets the active ones do a step. Schedules the next step. | 1047 | * Cycles through all agents and lets the active ones do a step. Schedules the next step. |
1047 | * | 1048 | * |
1048 | * @param solver the solver handle | 1049 | * @param cls the solver handle |
1049 | * @param tc task context for the scheduler | 1050 | * @param tc the task context for the scheduler |
1050 | */ | 1051 | */ |
1051 | static void | 1052 | static void |
1052 | ril_periodic_step (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) | 1053 | ril_periodic_step (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) |
@@ -1106,7 +1107,7 @@ agent_init (void *s, const struct GNUNET_PeerIdentity *peer) | |||
1106 | /** | 1107 | /** |
1107 | * Deallocate agent | 1108 | * Deallocate agent |
1108 | * | 1109 | * |
1109 | * @param s solver handle | 1110 | * @param solver the solver handle |
1110 | * @param agent the agent to retire | 1111 | * @param agent the agent to retire |
1111 | */ | 1112 | */ |
1112 | static void | 1113 | static void |
@@ -1127,10 +1128,10 @@ agent_die (struct GAS_RIL_Handle *solver, struct RIL_Peer_Agent *agent) | |||
1127 | /** | 1128 | /** |
1128 | * Returns the agent for a peer | 1129 | * Returns the agent for a peer |
1129 | * | 1130 | * |
1130 | * @param s solver handle | 1131 | * @param solver the solver handle |
1131 | * @param peer identity of the peer | 1132 | * @param peer the identity of the peer |
1132 | * @param create whether to create an agent if none is allocated yet | 1133 | * @param create whether or not to create an agent, if none is allocated yet |
1133 | * @return agent | 1134 | * @return the agent |
1134 | */ | 1135 | */ |
1135 | static struct RIL_Peer_Agent * | 1136 | static struct RIL_Peer_Agent * |
1136 | ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create) | 1137 | ril_get_agent (struct GAS_RIL_Handle *solver, const struct GNUNET_PeerIdentity *peer, int create) |
@@ -1259,7 +1260,7 @@ ril_cut_from_vector (void **old, | |||
1259 | * @param pref_rel the normalized preference value for this kind over all clients | 1260 | * @param pref_rel the normalized preference value for this kind over all clients |
1260 | */ | 1261 | */ |
1261 | void | 1262 | void |
1262 | GAS_ril_address_change_preference (void *s, | 1263 | GAS_ril_address_change_preference (void *solver, |
1263 | const struct GNUNET_PeerIdentity *peer, | 1264 | const struct GNUNET_PeerIdentity *peer, |
1264 | enum GNUNET_ATS_PreferenceKind kind, | 1265 | enum GNUNET_ATS_PreferenceKind kind, |
1265 | double pref_rel) | 1266 | double pref_rel) |