Add documentation to the Neuralnetworks HIDL HAL.
Bug: 63905942
Test: not needed
Change-Id: I1582d20e66ef939581d82f21088f0db0bc0f5eb7
diff --git a/neuralnetworks/1.0/IEvent.hal b/neuralnetworks/1.0/IEvent.hal
index cf71bbc..2ebda58 100644
--- a/neuralnetworks/1.0/IEvent.hal
+++ b/neuralnetworks/1.0/IEvent.hal
@@ -29,21 +29,15 @@
* indicate to the Neuralnetworks runtime whether the computation was
* successful or not, and that the corresponding output is ready to be
* consumed if the execution was successful.
- *
- * TODO: Mention that "notify" is also called by a runtime thread
- * during CPU fallback execution? Depends on whether the HIDL comments
- * are strictly for vendors or not.
*/
interface IEvent {
/**
- * IEvent::notify is called by the server thread (i.e. the thread doing the
- * work) to mark the event as completed so that any threads requiring the
- * corresponding resources can continue executing.
+ * IEvent::notify is called by the server thread (i.e., the thread doing
+ * the work) to mark the event as completed so that any threads requiring
+ * the corresponding output can continue executing.
*
- * @param status Status of the execution associated with the Event.
- * Should be SUCCESS or ERROR.
+ * @param status ErrorStatus::NONE if successful.
*/
oneway notify(ErrorStatus status);
-
};