diff --git a/ivette/src/frama-c/server.js b/ivette/src/frama-c/server.js index 37cd6bf32d8f92fb2d8fb71c647f6f8e86e62eb8..6a915b847cbebc4a190503cbee300af10b1bbcaf 100644 --- a/ivette/src/frama-c/server.js +++ b/ivette/src/frama-c/server.js @@ -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' ; diff --git a/ivette/src/frama-c/states.js b/ivette/src/frama-c/states.js index a602bb1430fcab581e7738fa5725802561edd0be..92308d76dd0c2ea48054ae16fbcd65eb125efbbe 100644 --- a/ivette/src/frama-c/states.js +++ b/ivette/src/frama-c/states.js @@ -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.' ;