]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: lua/event: add ServerEvent class header
authorAurelien DARRAGON <adarragon@haproxy.com>
Mon, 17 Apr 2023 15:24:48 +0000 (17:24 +0200)
committerChristopher Faulet <cfaulet@haproxy.com>
Fri, 5 May 2023 14:28:32 +0000 (16:28 +0200)
This is to make ServerEvent class easier to understand,
some additional info related to ServerEvent class may be
included here.

doc/lua-api/index.rst

index f75c6b3af742f2d4cfbed1f589ab12c8b44f48cf..d470491c7b5714896ab0de701246e9ac9951d936 100644 (file)
@@ -1487,6 +1487,12 @@ EventSub class
 ServerEvent class
 =================
 
+.. js:class:: ServerEvent
+
+This class is provided with every **SERVER** events.
+
+See :js:func:`core.event_sub()` for more info.
+
 .. js:attribute:: ServerEvent.name
 
   Contains the name of the server.