From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 27 Oct 2015 15:34:34 +0000 (+0100)
Subject: [4081] Stub documentation added.
X-Git-Tag: trac4106_base~1^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2c5966cb4a7c47ae7edd749c06ed84a0f23a3357;p=thirdparty%2Fkea.git

[4081] Stub documentation added.
---

diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox
index 9204a327cf..1f69e0adf4 100644
--- a/doc/devel/mainpage.dox
+++ b/doc/devel/mainpage.dox
@@ -102,6 +102,7 @@
  *   - @subpage allocengine
  * - @subpage libdhcp_ddns
  * - @subpage dhcpDatabaseBackends
+ * - @subpage dhcpEval
  * - @subpage configBackend
  *   - @subpage configBackendMotivation
  *   - @subpage configBackendJSONDesign
diff --git a/src/lib/eval/Makefile.am b/src/lib/eval/Makefile.am
index dba912d1b8..2627175768 100644
--- a/src/lib/eval/Makefile.am
+++ b/src/lib/eval/Makefile.am
@@ -16,6 +16,7 @@ libkea_eval_la_LDFLAGS  = -no-undefined -version-info 3:0:0
 libkea_eval_la_LDFLAGS += $(CRYPTO_LDFLAGS)
 
 EXTRA_DIST  = eval.dox
+EXTRA_DIST += eval_messages.mes
 
 # Define rule to build logging source files from message file
 eval_messages.h eval_messages.cc: s-messages
@@ -32,4 +33,4 @@ s-messages: eval_messages.mes
 # first.
 BUILT_SOURCES = eval_messages.h eval_messages.cc
 
-CLEANFILES = expr_messages.h expr_messages.cc
+CLEANFILES = eval_messages.h eval_messages.cc
diff --git a/src/lib/eval/eval.dox b/src/lib/eval/eval.dox
new file mode 100644
index 0000000000..314834d287
--- /dev/null
+++ b/src/lib/eval/eval.dox
@@ -0,0 +1,20 @@
+// Copyright (C) 2012-2015  Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+/**
+  @page dhcpEval Expression evaluation (client classification)
+
+  @todo: Document how the expression evaluation is implemented.
+
+ */