Skip to content
Snippets Groups Projects
Commit 3d6c6b3d authored by Loïc Correnson's avatar Loïc Correnson
Browse files

[ivette] prettier events documentation

parent 455a455c
No related branches found
No related tags found
No related merge requests found
......@@ -21,9 +21,10 @@ import { Request } from 'zeromq' ;
/**
@event
@name 'frama-c.server'
@summary Server Status Notification Event
@description
Event `'frama-c.server'`.
Exported as `Server.SERVER' in public API.
*/
export const SERVER = 'frama-c.server' ;
......
......@@ -16,17 +16,20 @@ const NONE = [ undefined, () => undefined ]; // No-state
/**
@event
@name 'frama-c.project'
@summary Current Project Updates
@description
Event `'frama-c.project'`.
Exported as `State.PROJECT` in public API.
*/
export const PROJECT = 'frama-c.project' ;
/**
@event
@summary State Notification Event (prefix)
@name 'frama-c.state.*'
@summary State Notification Events.
@description
Event `'frama-c.state.<id>'` for project `<id>`.
The prefix `'frama-c-state.'` is exported as `States.STATE` in public API.
*/
export const STATE = 'frama-c.state.' ;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment