Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-03 03:01:44 +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()

10
wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/InterruptableSensorBase.java
View File

@@ -73,13 +73,13 @@ public abstract class InterruptableSensorBase extends SensorBase {
abstract byte getModuleForRouting();
/**
* Request interrupts asynchronously on this digital input.
* Request one of the 8 interrupts asynchronously on this digital input.
*
* @param handler
* The {@link InterruptHandlerFunction} that contains the method
* {@link InterruptHandlerFunction#interruptFired(int, Object)} that
* will be called whenever there is an interrupt on this device.
* Request interrupts in synchronus mode where the user program
* Request interrupts in synchronous mode where the user program
* interrupt handler will be called when an interrupt occurs. The
* default is interrupt on rising edges only.
*/
@@ -105,10 +105,10 @@ public abstract class InterruptableSensorBase extends SensorBase {
}
/**
* Request interrupts synchronously on this digital input. Request
* 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. The default is interrupt on
* rising edges only.
* explicitly wait for the interrupt to occur using {@link waitForInterrupt}.
* The default is interrupt on rising edges only.
*/
public void requestInterrupts() {
if(m_interrupt != null){