[GNUnet-SVN] r29969 - gnunet/src/ats

[gnunet]

Author: wachs
Date: 2013-10-08 11:43:17 +0200 (Tue, 08 Oct 2013)
New Revision: 29969

Modified:
   gnunet/src/ats/gnunet-service-ats_addresses.h
Log:
improved documentation


Modified: gnunet/src/ats/gnunet-service-ats_addresses.h
===================================================================
--- gnunet/src/ats/gnunet-service-ats_addresses.h       2013-10-08 09:36:57 UTC 
(rev 29968)
+++ gnunet/src/ats/gnunet-service-ats_addresses.h       2013-10-08 09:43:17 UTC 
(rev 29969)
@@ -734,13 +734,21 @@
     enum GNUNET_ATS_PreferenceKind kind, float score_abs);
 
 /**
- * Change the preference for a peer
+ * Application feedback on how good preference requirements are fulfilled
+ * for a specific preference in the given time scope [now - scope .. now]
  *
+ * An application notifies ATS if (and only if) it has feedback information
+ * for a specific property. This value is valid until the feedback score is
+ * updated by the application.
+ *
+ * If the application has no feedback for this preference kind the application
+ * will not explicitly call.
+ *
  * @param handle the address handle
- * @param application the client sending this request
+ * @param application the application sending this request
  * @param peer the peer id
  * @param scope the time interval this valid for: [now - scope .. now]
- * @param kind the preference kind to change
+ * @param kind the preference kind this feedback is intended for
  * @param score_abs the new preference score
  */
 void