Added skeleton Doc files for the whole developer's documentation.

This commit is contained in:
Martin Mares 2000-05-05 17:17:42 +00:00
parent b177724896
commit ab1129c1bd
14 changed files with 60 additions and 0 deletions

7
Doc Normal file
View file

@ -0,0 +1,7 @@
C lib
C nest
C conf
C filter
C proto
C sysdep
C client

2
client/Doc Normal file
View file

@ -0,0 +1,2 @@
F client Client
.S client.c commands.c

2
conf/Doc Normal file
View file

@ -0,0 +1,2 @@
F conf Configuration
.S conf.c

1
filter/Doc Normal file
View file

@ -0,0 +1 @@
H Filters

26
lib/Doc Normal file
View file

@ -0,0 +1,26 @@
H Library
.F csum Checksums and hash functions
..S checksum.c md5.c
.F ip IP addresses
..S ip.c ipv4.c ipv6.c
.F list Linked lists
..S lists.c
.H Resource management
..F gen Generic resource functions
...S resource.c
..F mempool Memory pools
...S mempool.c
..F slab Slabs
...S slab.c
..F sock Sockets
...S socket.h
.H Miscellaneous functions
..F bit Bit operations
...S bitops.c
..F event Events
...S event.c
..F pat Pattern matching
...S patmatch.c
..F printf Printf
...S printf.c
..F unaligned Unaligned access

1
nest/Doc Normal file
View file

@ -0,0 +1 @@
H Core

6
proto/Doc Normal file
View file

@ -0,0 +1,6 @@
H Protocols
.C bgp
.C ospf
.C pipe
.C rip
.C static

1
proto/bgp/Doc Normal file
View file

@ -0,0 +1 @@
H BGP

1
proto/ospf/Doc Normal file
View file

@ -0,0 +1 @@
H OSPF

1
proto/pipe/Doc Normal file
View file

@ -0,0 +1 @@
H Pipe

2
proto/rip/Doc Normal file
View file

@ -0,0 +1,2 @@
F rip RIP
.S rip.c

1
proto/static/Doc Normal file
View file

@ -0,0 +1 @@
H Static

2
sysdep/Doc Normal file
View file

@ -0,0 +1,2 @@
H System-dependent parts
.C unix

7
sysdep/unix/Doc Normal file
View file

@ -0,0 +1,7 @@
H UNIX
.F io I/O Functions
..S io.c
.F log Logging Functions
..S log.c
.F krt Kernel Syncer
..S krt.c