From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 7 Aug 2012 04:56:51 +0000 (-0700)
Subject: [rt25901_atf] Skeleton documentation for architecture, contrib and omapi
X-Git-Tag: v4_3_0a1~77^2~12
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e04feb1f05af5aee300ea14c6a8c1e4cab366555;p=thirdparty%2Fdhcp.git

[rt25901_atf] Skeleton documentation for architecture, contrib and omapi
---

diff --git a/doc/devel/arch.dox b/doc/devel/arch.dox
new file mode 100644
index 000000000..6720f4ae3
--- /dev/null
+++ b/doc/devel/arch.dox
@@ -0,0 +1,11 @@
+/**
+
+@page archSrv Server Architecture
+
+@todo: Describe high level server architecture here.
+
+@page archCli Client Architecture
+
+@todo: Describe high level client architecture here.
+
+*/
\ No newline at end of file
diff --git a/doc/devel/contrib.dox b/doc/devel/contrib.dox
new file mode 100644
index 000000000..c978b8807
--- /dev/null
+++ b/doc/devel/contrib.dox
@@ -0,0 +1,12 @@
+/**
+@page contrib Contributing to DHCP
+
+@section contribDir 3rd party contributions in contrib/ directory
+
+ @todo: Describe contrib/ dir
+
+@section codingGuidelines Coding Guidelines
+
+ @todo: (... if people want to contribute significant code)
+
+*/
diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox
index bc965ddff..250882689 100644
--- a/doc/devel/mainpage.dox
+++ b/doc/devel/mainpage.dox
@@ -8,8 +8,21 @@
  http://www.isc.org/software/dhcp website.
 
  @section toc Table Of Contents
+  - @subpage archSrv
+  - @subpage archCli
   - @subpage tests
+    - @subpage testsOverview
+    - @subpage testsAtf
+    - @subpage testsAtfAdding
+    - @subpage testsAtfCoding
   - @subpage debug
+  - @subpage omapi
+    - @subpage omapiIntro
+    - @subpage omapiC
+    - @subpage dhcpctl
+  - @subpage contrib
+    - @subpage contribDir
+    - @subpage codingGuidelines
 
  Note: some of the links below may not work if corresponding logs are not available.<br/>
 
diff --git a/doc/devel/omapi.dox b/doc/devel/omapi.dox
new file mode 100644
index 000000000..c6423cec2
--- /dev/null
+++ b/doc/devel/omapi.dox
@@ -0,0 +1,15 @@
+/**
+@page omapi OMAPI Interface
+
+@section omapiIntro Introduction
+
+ @todo: Description of OMAPI and dhcpctl
+
+@section omapiC Object Management API
+
+ @todo: Essentially omapi.3
+
+@section dhcpctl dhcpctl Reference Guide
+ @todo: Essentially dhcpctl.3
+
+*/