Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-21 01:01:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Interrupt Javadocs (fixes artf3492 and artf3602)

Browse Source 
Change-Id: Iad66841266a2d5ff606f7e27e90f7c975143245c
This commit is contained in:
Kevin O'Connor
2014-10-29 15:23:55 -04:00
parent 80194e9809
commit fba155804e
2 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
wpilibc/wpilibC++Devices/src/InterruptableSensorBase.cpp
View File

@@ -21,6 +21,13 @@ InterruptableSensorBase::~InterruptableSensorBase()
}
/**
* Request one of the 8 interrupts asynchronously on this digital input.
* Request interrupts in asynchronous mode where the user's interrupt handler will be
* called when the interrupt fires. Users that want control over the thread priority
* should use the synchronous method with their own spawned thread.
* The default is interrupt on rising edges only.
*/
void InterruptableSensorBase::RequestInterrupts(InterruptHandlerFunction handler, void *param)
{
if (StatusIsFatal()) return;
@@ -44,9 +51,9 @@ void InterruptableSensorBase::RequestInterrupts(InterruptHandlerFunction handler
}
/**
* Request interrupts synchronously on this digital input.
* Request interrupts in synchronus mode where the user program will have to explicitly
* wait for the interrupt to occur.
* Request one of the 8 interrupts synchronously on this digital input.
* Request interrupts in synchronous mode where the user program will have to explicitly
* wait for the interrupt to occur using WaitForInterrupt.
* The default is interrupt on rising edges only.
*/
void InterruptableSensorBase::RequestInterrupts()