GSoC: Documentation #2

[project/luci.git] / libs / lucid-http / luasrc / lucid / http / DirectoryPublisher.lua

diff --git a/libs/lucid-http/luasrc/lucid/http/DirectoryPublisher.lua b/libs/lucid-http/luasrc/lucid/http/DirectoryPublisher.lua
index f471781a93c8b3b3f5c61118f0bf2fa82a6c01f7..b57b5586a21554ff2b001d7d86d526a4cf14788f 100644 (file)
--- a/libs/lucid-http/luasrc/lucid/http/DirectoryPublisher.lua
+++ b/libs/lucid-http/luasrc/lucid/http/DirectoryPublisher.lua
@@ -18,6 +18,9 @@ local srv = require "luci.lucid.http.server"
 module "luci.lucid.http.DirectoryPublisher"
 
 
+--- Prepare a directory publisher and assign it to a given Virtual Host.
+-- @param server HTTP daemon object
+-- @param config publisher configuration
 function factory(server, config)
        config.domain = config.domain or ""
        local vhost = server:get_vhosts()[config.domain]