summaryrefslogtreecommitdiffstats
path: root/aconf/model/net.lua
diff options
context:
space:
mode:
authorKaarle Ritvanen <kaarle.ritvanen@datakunkku.fi>2015-04-03 10:40:28 +0300
committerKaarle Ritvanen <kaarle.ritvanen@datakunkku.fi>2015-04-10 18:17:00 +0300
commita92dc45aee3f599926c77294328db38c5b2544eb (patch)
tree0f31580b868245cabe733864f9d99901730c3279 /aconf/model/net.lua
parent3baaf91de453d35b095881478be8d88b3fc2b97a (diff)
downloadaconf-a92dc45aee3f599926c77294328db38c5b2544eb.tar.bz2
aconf-a92dc45aee3f599926c77294328db38c5b2544eb.tar.xz
docs: describe functionality used in the dnsmasq modulev0.5.0
Diffstat (limited to 'aconf/model/net.lua')
-rw-r--r--aconf/model/net.lua6
1 files changed, 6 insertions, 0 deletions
diff --git a/aconf/model/net.lua b/aconf/model/net.lua
index 6de00f0..8ca7921 100644
--- a/aconf/model/net.lua
+++ b/aconf/model/net.lua
@@ -3,6 +3,7 @@ Copyright (c) 2012-2015 Kaarle Ritvanen
See LICENSE file for license details
--]]
+--- @module aconf.model
local M = {}
local raise = require('aconf.error').raise
@@ -168,6 +169,9 @@ function M.IPv6Address:mask2cidr(mask) return mask end
function M.IPv6Address:cidr2mask(cidr) return cidr end
+--- IP address field, inherits @{Field}. Accepts both IPv4 and IPv6
+-- address values.
+-- @klass net.IPAddress
M.IPAddress = class(Union)
function M.IPAddress:init(params)
@@ -190,6 +194,8 @@ end
local domain_pattern = '[A-Za-z%d%.%-]+%.[A-Za-z][A-Za-z]+'
+--- domain name field, inherits @{String}.
+-- @klass net.DomainName
M.DomainName = class(String)
function M.DomainName:init(params)
super(self, M.DomainName):init(update(params, {pattern=domain_pattern}))