From: Tobias Ulmer <tu@emlix.com>
Date: Mon, 6 Aug 2012 09:51:38 +0000 (+0200)
Subject: Add luadoc for cache.valid_server()
X-Git-Tag: e2factory-2.3.13rc1~205
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=bdfd746b2ae146e367fe8a48b750d349d4687bc5;p=e2factory.git

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 10cb6b3..2d84f10 100644
--- 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