]> git.ipfire.org Git - thirdparty/dhcp.git/commitdiff
[rt25901_atf] Skeleton documentation for architecture, contrib and omapi
authorTomek Mrugalski <tomasz@isc.org>
Tue, 7 Aug 2012 04:56:51 +0000 (21:56 -0700)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 7 Aug 2012 04:56:51 +0000 (21:56 -0700)
doc/devel/arch.dox [new file with mode: 0644]
doc/devel/contrib.dox [new file with mode: 0644]
doc/devel/mainpage.dox
doc/devel/omapi.dox [new file with mode: 0644]

diff --git a/doc/devel/arch.dox b/doc/devel/arch.dox
new file mode 100644 (file)
index 0000000..6720f4a
--- /dev/null
@@ -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 (file)
index 0000000..c978b88
--- /dev/null
@@ -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)
+
+*/
index bc965ddffb09b6447369de73acfb997ba609c5e7..25088268990724c5794a14215c1d7fe29b51ca9d 100644 (file)
@@ -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 (file)
index 0000000..c6423ce
--- /dev/null
@@ -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
+
+*/