PUD: update a function comment
authorFerry Huberts <f.huberts@mindef.nl>
Tue, 28 Jun 2011 13:44:08 +0000 (15:44 +0200)
committerFerry Huberts <f.huberts@mindef.nl>
Thu, 30 Jun 2011 15:28:20 +0000 (17:28 +0200)
Signed-off-by: Ferry Huberts <f.huberts@mindef.nl>
lib/pud/src/receiver.c

index 0f884c6..de5c356 100644 (file)
@@ -183,15 +183,20 @@ static void txToAllOlsrInterfaces(void) {
 }
 
 /**
- * Detemines whether we are moving by comparing fields from the average
- * position against those of the last transmitted position.
- *
- * MUST be called which the position average list locked.
- *
- * @param posAvgEntry
- * the average position
- * @param lastTxEntry
- * the last transmitted position
+ Detemines whether we are moving by comparing fields from the average
+ position against those of the last transmitted position.
+
+ MUST be called which the position average list locked.
+
+ @param posAvgEntry
+ the average position
+ @param lastTxEntry
+ the last transmitted position
+
+ @return
+ - SET when we are moving
+ - UNSET when we are not moving
+ - UNKNOWN when we don't know / can't determine
  */
 static TristateBoolean detemineMoving(PositionUpdateEntry * posAvgEntry,
                PositionUpdateEntry * lastTxEntry) {