From a92dc45aee3f599926c77294328db38c5b2544eb Mon Sep 17 00:00:00 2001
From: Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi>
Date: Fri, 3 Apr 2015 10:40:28 +0300
Subject: docs: describe functionality used in the dnsmasq module

---
 aconf/model/net.lua | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'aconf/model/net.lua')

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}))
-- 
cgit v1.2.3