Add luadoc for cache.valid_server()

Signed-off-by: Tobias Ulmer <tu@emlix.com>

diff --git a/generic/cache.lua b/generic/cache.lua
index 10cb6b3a3b9b4751090fe2fce9e3c24dab249c2b..2d84f10bd34673b169bfd3b4bf499941777666d3 100644 (file)
--- a/generic/cache.lua
+++ b/generic/cache.lua
@@ -182,6 +182,11 @@ function cache.ce_by_server(c, server)
     return nil, new_error("no cache entry for server: %s", server)
 end
 
+--- check if server is valid
+-- @param c the cache table
+-- @param server the server name
+-- @return true if the server is valid, false otherwise
+-- @return an error object on failure
 function cache.valid_server(c, server)
     if cache.ce_by_server(c, server) then
         return true