Updates the InterrupatableSensorBase documentation to reflect the bug

described in artf3623.

Change-Id: I5f93dea65202cf30ba67c063eb8c90bedbfe43ae
This commit is contained in:
Fredric Silberberg
2014-12-24 14:19:01 -05:00
parent a55f34646d
commit 7687028269

View File

@@ -101,7 +101,9 @@ void InterruptableSensorBase::CancelInterrupts()
}
/**
* In synchronous mode, wait for the defined interrupt to occur.
* In synchronous mode, wait for the defined interrupt to occur. You should <b>NOT</b> attempt to read the
* sensor from another thread while waiting for an interrupt. This is not threadsafe, and can cause
* memory corruption
* @param timeout Timeout in seconds
* @param ignorePrevious If true, ignore interrupts that happened before
* WaitForInterrupt was called.