From: Aurelien DARRAGON <adarragon@haproxy.com>
Date: Mon, 17 Apr 2023 15:24:48 +0000 (+0200)
Subject: DOC: lua/event: add ServerEvent class header
X-Git-Tag: v2.8-dev10~26
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c4ae8906b9e003ad29923562b406b533c2138e81;p=thirdparty%2Fhaproxy.git

DOC: lua/event: add ServerEvent class header

This is to make ServerEvent class easier to understand,
some additional info related to ServerEvent class may be
included here.
---

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index f75c6b3af7..d470491c7b 100644
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -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.