]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: lua: add sticktable class reference from Proxy.stktable
authorAurelien DARRAGON <adarragon@haproxy.com>
Thu, 23 Nov 2023 12:47:54 +0000 (13:47 +0100)
committerChristopher Faulet <cfaulet@haproxy.com>
Fri, 24 Nov 2023 15:27:55 +0000 (16:27 +0100)
Add a reference hint for the sticktable class and mention it from
Proxy.stktable documentation to allow easy navigation from a web
browser.

doc/lua-api/index.rst

index 5716312973e70d39e156e3e2627d99ab6952abf6..eadf2f2f38ff316f044255e7a99fc6bc64b03482 100644 (file)
@@ -1087,7 +1087,8 @@ Proxy class
 
 .. js:attribute:: Proxy.stktable
 
-  Contains a stick table object attached to the proxy.
+  Contains a stick table object of type :ref:`sticktable_class` attached to the
+  proxy.
 
 .. js:attribute:: Proxy.listeners
 
@@ -3730,6 +3731,8 @@ AppletTCP class
   :see: :js:func:`AppletTCP.unset_var`
   :see: :js:func:`AppletTCP.set_var`
 
+.. _sticktable_class:
+
 StickTable class
 ================