From 3d6c6b3da12aa683cd48e325358fceab7fb345ee Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Loi=CC=88c=20Correnson?= <loic.correnson@cea.fr>
Date: Thu, 13 Feb 2020 08:27:17 +0100
Subject: [PATCH] [ivette] prettier events documentation
---
ivette/src/frama-c/server.js | 3 ++-
ivette/src/frama-c/states.js | 7 +++++--
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/ivette/src/frama-c/server.js b/ivette/src/frama-c/server.js
index 37cd6bf32d8..6a915b847cb 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 a602bb1430f..92308d76dd0 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.' ;
--
GitLab