Merge "Updates the InterrupatableSensorBase documentation to reflect the bug described in artf3623."

This commit is contained in:
Brad Miller (WPI)
2014-12-26 13:28:20 -08:00
committed by Gerrit Code Review

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.