[#2583] Added dox file to libkea_tcp

Changes to be committed:
	modified:   doc/devel/Doxyfile
	modified:   doc/sphinx/mes-files.txt
	modified:   doc/sphinx/mes_files.mk
	new file:   src/lib/tcp/libkea_tcp.dox

diff --git a/doc/devel/Doxyfile b/doc/devel/Doxyfile
index 66c2b7d8d4bce82912cb4417cfc0bf74950c1de0..05475babbfb3a13ab28d487c9c69c7a650ebdd15 100644 (file)
--- a/doc/devel/Doxyfile
+++ b/doc/devel/Doxyfile
@@ -892,6 +892,7 @@ INPUT                  = ../../src/bin/agent \
                          ../../src/lib/pgsql \
                          ../../src/lib/process \
                          ../../src/lib/stats \
+                         ../../src/lib/tcp \
                          ../../src/lib/testutils \
                          ../../src/lib/util \
                          ../../src/lib/util/encode \

diff --git a/doc/sphinx/mes-files.txt b/doc/sphinx/mes-files.txt
index 6d802c9305920c42e191d8f65b281244c68a87a8..58c46761e7d83c858681ad535106aedffb2c9d30 100644 (file)
--- a/doc/sphinx/mes-files.txt
+++ b/doc/sphinx/mes-files.txt
@@ -21,6 +21,7 @@ src/lib/process/process_messages.mes
 src/lib/asiodns/asiodns_messages.mes
 src/lib/eval/eval_messages.mes
 src/lib/d2srv/d2_messages.mes
+src/lib/tcp/tcp_messages.mes
 src/bin/dhcp4/dhcp4_messages.mes
 src/bin/agent/ca_messages.mes
 src/bin/dhcp6/dhcp6_messages.mes

diff --git a/doc/sphinx/mes_files.mk b/doc/sphinx/mes_files.mk
index ca612d8ac8588f3e12ee3ac115667a9f5b5270b7..29517b24eec1f0f77422c890edb6e96de78e7f13 100644 (file)
--- a/doc/sphinx/mes_files.mk
+++ b/doc/sphinx/mes_files.mk
@@ -21,6 +21,7 @@ mes_files += $(top_srcdir)/src/lib/process/process_messages.mes
 mes_files += $(top_srcdir)/src/lib/asiodns/asiodns_messages.mes
 mes_files += $(top_srcdir)/src/lib/eval/eval_messages.mes
 mes_files += $(top_srcdir)/src/lib/d2srv/d2_messages.mes
+mes_files += $(top_srcdir)/src/lib/tcp/tcp_messages.mes
 mes_files += $(top_srcdir)/src/bin/dhcp4/dhcp4_messages.mes
 mes_files += $(top_srcdir)/src/bin/agent/ca_messages.mes
 mes_files += $(top_srcdir)/src/bin/dhcp6/dhcp6_messages.mes

diff --git a/src/lib/tcp/libkea_tcp.dox b/src/lib/tcp/libkea_tcp.dox
new file mode 100644 (file)
index 0000000..36cf637
--- /dev/null
+++ b/src/lib/tcp/libkea_tcp.dox
@@ -0,0 +1,15 @@
+// Copyright (C) 2022 Internet Systems Consortium, Inc. ("ISC")
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+/**
+@page libkea_tcp libkea-kea_tcp - TCP Listener Library
+
+@section libkea_tcpIntro Introduction
+
+This is a library of classes (in the isc::kea_tcp namespace) that provide
+the ability to accept connections, listen for and respond to TCP messages.
+
+*/