"git@developer.sourcefind.cn:OpenDAS/autoawq.git" did not exist on "f83537937f9731c0b669efa92425ac7c06311c5c"
Commit 51a90498 authored by Jonas Kaufmann's avatar Jonas Kaufmann Committed by Antoine Kaufmann
Browse files

lib/simbricks/base/if.h: fix docstring for SimBricksBaseIfOutSync()

The doc string says to return 1 in the case of an unnecessary sync, which the implementation actually doesn't do. It instead considers an unnecessary sync as success, which is generally also the intended behavior.
parent dee819ae
...@@ -337,7 +337,7 @@ static inline void SimbricksBaseIfOutSend( ...@@ -337,7 +337,7 @@ static inline void SimbricksBaseIfOutSend(
* *
* @param base_if Base interface handle (connected). * @param base_if Base interface handle (connected).
* @param timestamp Current timestamp (in picoseconds). * @param timestamp Current timestamp (in picoseconds).
* @return 0 if sync successfully sent, 1 if sync was unnecessary, -1 if a * @return 0 if sync successfully sent or sync was unnecessary, -1 if a
* necessary sync message could not be sent because the queue is full. * necessary sync message could not be sent because the queue is full.
*/ */
static inline int SimbricksBaseIfOutSync(struct SimbricksBaseIf *base_if, static inline int SimbricksBaseIfOutSync(struct SimbricksBaseIf *base_if,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment