d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a disclaimer regarding public/internal functions to every subsystem for

Browse Source 
now.

Discussed on:			cvs-all
Helped with the wording:	"Ben Kaduk" <minimarmot@gmail.com>
This commit is contained in:
Alexander Leidinger 2006-05-28 15:25:18 +00:00
parent 451651c72e
commit 39e2bd0bdb
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=159010
38 changed files with 68 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sys/doc/subsys/Doxyfile-cam
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/cam/
INPUT = $(DOXYGEN_SRC_PATH)/cam/ $(NOTREVIEWED)
GENERATE_TAGFILE = cam/cam.tag

2
sys/doc/subsys/Doxyfile-crypto
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/crypto/
INPUT = $(DOXYGEN_SRC_PATH)/crypto/ $(NOTREVIEWED)
GENERATE_TAGFILE = crypto/crypto.tag

3
sys/doc/subsys/Doxyfile-dev_pci
View File

@ -12,7 +12,8 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/dev/pci/ \
$(DOXYGEN_SRC_PATH)/$(DOXYGEN_TARGET_ARCH)/pci/
$(DOXYGEN_SRC_PATH)/$(DOXYGEN_TARGET_ARCH)/pci/ \
$(NOTREVIEWED)
GENERATE_TAGFILE = dev_pci/dev_pci.tag

2
sys/doc/subsys/Doxyfile-dev_sound
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/dev/sound/
INPUT = $(DOXYGEN_SRC_PATH)/dev/sound/ $(NOTREVIEWED)
GENERATE_TAGFILE = dev_sound/dev_sound.tag
TAGFILES = dev_pci/dev_pci.tag=../../dev_pci/html \

2
sys/doc/subsys/Doxyfile-dev_usb
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/dev/usb/
INPUT = $(DOXYGEN_SRC_PATH)/dev/usb/ $(NOTREVIEWED)
GENERATE_TAGFILE = dev_usb/dev_usb.tag
TAGFILES = dev_pci/dev_pci.tag=../../dev_pci/html

2
sys/doc/subsys/Doxyfile-geom
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/geom/
INPUT = $(DOXYGEN_SRC_PATH)/geom/ $(NOTREVIEWED)
GENERATE_TAGFILE = geom/geom.tag

2
sys/doc/subsys/Doxyfile-i4b
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/i4b/
INPUT = $(DOXYGEN_SRC_PATH)/i4b/ $(NOTREVIEWED)
GENERATE_TAGFILE = i4b/i4b.tag
TAGFILES = dev_pci/dev_pci.tag=../../dev_pci/html

2
sys/doc/subsys/Doxyfile-kern
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/kern/
INPUT = $(DOXYGEN_SRC_PATH)/kern/ $(NOTREVIEWED)
GENERATE_TAGFILE = kern/kern.tag

2
sys/doc/subsys/Doxyfile-libkern
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/libkern/
INPUT = $(DOXYGEN_SRC_PATH)/libkern/ $(NOTREVIEWED)
GENERATE_TAGFILE = libkern/libkern.tag

3
sys/doc/subsys/Doxyfile-linux
View File

@ -11,7 +11,8 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/compat/linux $(DOXYGEN_LINUX_PATH)
INPUT = $(DOXYGEN_SRC_PATH)/compat/linux \
$(DOXYGEN_LINUX_PATH) $(NOTREVIEWED)
GENERATE_TAGFILE = linux/linux.tag

2
sys/doc/subsys/Doxyfile-net80211
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/net80211/
INPUT = $(DOXYGEN_SRC_PATH)/net80211/ $(NOTREVIEWED)
GENERATE_TAGFILE = net80211/net80211.tag

2
sys/doc/subsys/Doxyfile-netgraph
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netgraph/
INPUT = $(DOXYGEN_SRC_PATH)/netgraph/ $(NOTREVIEWED)
GENERATE_TAGFILE = netgraph/netgraph.tag

2
sys/doc/subsys/Doxyfile-netinet
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netinet/
INPUT = $(DOXYGEN_SRC_PATH)/netinet/ $(NOTREVIEWED)
GENERATE_TAGFILE = netinet/netinet.tag

2
sys/doc/subsys/Doxyfile-netinet6
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netinet6/
INPUT = $(DOXYGEN_SRC_PATH)/netinet6/ $(NOTREVIEWED)
GENERATE_TAGFILE = netinet6/netinet6.tag

2
sys/doc/subsys/Doxyfile-netipsec
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netipsec/
INPUT = $(DOXYGEN_SRC_PATH)/netipsec/ $(NOTREVIEWED)
GENERATE_TAGFILE = netipsec/netipsec.tag

2
sys/doc/subsys/Doxyfile-opencrypto
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/opencrypto/
INPUT = $(DOXYGEN_SRC_PATH)/opencrypto/ $(NOTREVIEWED)
GENERATE_TAGFILE = opencrypto/opencrypto.tag

2
sys/doc/subsys/Doxyfile-vm
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/vm/
INPUT = $(DOXYGEN_SRC_PATH)/vm/ $(NOTREVIEWED)
GENERATE_TAGFILE = vm/vm.tag

1
sys/doc/subsys/Makefile
View File

@ -92,6 +92,7 @@ ${.OBJDIR}/${target}/${target}.tag:
DOXYGEN_SRC_INCLUDE_PATH="${S}/sys ${S}/../include ${S}/${TARGET_ARCH}/include" \
DOXYGEN_TARGET_ARCH=${TARGET_ARCH} \
DOXYGEN_LINUX_PATH=${DOXYGEN_LINUX_PATH} \
NOTREVIEWED=${.CURDIR}/notreviewed.dox \
doxygen ${.CURDIR}/Doxyfile-${target}
@echo "API docs for ${target} are now available in ${.OBJDIR}/${target}/." | /usr/bin/fmt

14
sys/doc/subsys/notreviewed.dox Normal file
View File

@ -0,0 +1,14 @@
/* $FreeBSD$ */
/** @mainpage
* <b>IMPORTANT:</b> This API documentation may contain both functions which
* are public and functions that are for internal use only. Since we have not
* reviewed every part of the documentation yet, <i>some internal functions
* are not marked as such</i>. Until we finish reviewing the API documentation
* and add appropriate comments to functions which are only for internal use,
* you should take this into account. In case you want to use a function of
* this kernel subsystem in another kernel subsystem you should search for
* precedence of use outside this subsystem. If the function is not used
* outside this subsystem you should ask on the mailinglists about it, else
* you risk breaking something.
*/

2
tools/kerneldoc/subsys/Doxyfile-cam
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/cam/
INPUT = $(DOXYGEN_SRC_PATH)/cam/ $(NOTREVIEWED)
GENERATE_TAGFILE = cam/cam.tag

2
tools/kerneldoc/subsys/Doxyfile-crypto
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/crypto/
INPUT = $(DOXYGEN_SRC_PATH)/crypto/ $(NOTREVIEWED)
GENERATE_TAGFILE = crypto/crypto.tag

3
tools/kerneldoc/subsys/Doxyfile-dev_pci
View File

@ -12,7 +12,8 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/dev/pci/ \
$(DOXYGEN_SRC_PATH)/$(DOXYGEN_TARGET_ARCH)/pci/
$(DOXYGEN_SRC_PATH)/$(DOXYGEN_TARGET_ARCH)/pci/ \
$(NOTREVIEWED)
GENERATE_TAGFILE = dev_pci/dev_pci.tag

2
tools/kerneldoc/subsys/Doxyfile-dev_sound
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/dev/sound/
INPUT = $(DOXYGEN_SRC_PATH)/dev/sound/ $(NOTREVIEWED)
GENERATE_TAGFILE = dev_sound/dev_sound.tag
TAGFILES = dev_pci/dev_pci.tag=../../dev_pci/html \

2
tools/kerneldoc/subsys/Doxyfile-dev_usb
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/dev/usb/
INPUT = $(DOXYGEN_SRC_PATH)/dev/usb/ $(NOTREVIEWED)
GENERATE_TAGFILE = dev_usb/dev_usb.tag
TAGFILES = dev_pci/dev_pci.tag=../../dev_pci/html

2
tools/kerneldoc/subsys/Doxyfile-geom
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/geom/
INPUT = $(DOXYGEN_SRC_PATH)/geom/ $(NOTREVIEWED)
GENERATE_TAGFILE = geom/geom.tag

2
tools/kerneldoc/subsys/Doxyfile-i4b
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/i4b/
INPUT = $(DOXYGEN_SRC_PATH)/i4b/ $(NOTREVIEWED)
GENERATE_TAGFILE = i4b/i4b.tag
TAGFILES = dev_pci/dev_pci.tag=../../dev_pci/html

2
tools/kerneldoc/subsys/Doxyfile-kern
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/kern/
INPUT = $(DOXYGEN_SRC_PATH)/kern/ $(NOTREVIEWED)
GENERATE_TAGFILE = kern/kern.tag

2
tools/kerneldoc/subsys/Doxyfile-libkern
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/libkern/
INPUT = $(DOXYGEN_SRC_PATH)/libkern/ $(NOTREVIEWED)
GENERATE_TAGFILE = libkern/libkern.tag

3
tools/kerneldoc/subsys/Doxyfile-linux
View File

@ -11,7 +11,8 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/compat/linux $(DOXYGEN_LINUX_PATH)
INPUT = $(DOXYGEN_SRC_PATH)/compat/linux \
$(DOXYGEN_LINUX_PATH) $(NOTREVIEWED)
GENERATE_TAGFILE = linux/linux.tag

2
tools/kerneldoc/subsys/Doxyfile-net80211
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/net80211/
INPUT = $(DOXYGEN_SRC_PATH)/net80211/ $(NOTREVIEWED)
GENERATE_TAGFILE = net80211/net80211.tag

2
tools/kerneldoc/subsys/Doxyfile-netgraph
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netgraph/
INPUT = $(DOXYGEN_SRC_PATH)/netgraph/ $(NOTREVIEWED)
GENERATE_TAGFILE = netgraph/netgraph.tag

2
tools/kerneldoc/subsys/Doxyfile-netinet
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netinet/
INPUT = $(DOXYGEN_SRC_PATH)/netinet/ $(NOTREVIEWED)
GENERATE_TAGFILE = netinet/netinet.tag

2
tools/kerneldoc/subsys/Doxyfile-netinet6
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netinet6/
INPUT = $(DOXYGEN_SRC_PATH)/netinet6/ $(NOTREVIEWED)
GENERATE_TAGFILE = netinet6/netinet6.tag

2
tools/kerneldoc/subsys/Doxyfile-netipsec
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/netipsec/
INPUT = $(DOXYGEN_SRC_PATH)/netipsec/ $(NOTREVIEWED)
GENERATE_TAGFILE = netipsec/netipsec.tag

2
tools/kerneldoc/subsys/Doxyfile-opencrypto
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#--------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/opencrypto/
INPUT = $(DOXYGEN_SRC_PATH)/opencrypto/ $(NOTREVIEWED)
GENERATE_TAGFILE = opencrypto/opencrypto.tag

2
tools/kerneldoc/subsys/Doxyfile-vm
View File

@ -11,7 +11,7 @@ EXTRACT_ALL = YES # for undocumented src, no warnings enabled
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = $(DOXYGEN_SRC_PATH)/vm/
INPUT = $(DOXYGEN_SRC_PATH)/vm/ $(NOTREVIEWED)
GENERATE_TAGFILE = vm/vm.tag

1
tools/kerneldoc/subsys/Makefile
View File

@ -92,6 +92,7 @@ ${.OBJDIR}/${target}/${target}.tag:
DOXYGEN_SRC_INCLUDE_PATH="${S}/sys ${S}/../include ${S}/${TARGET_ARCH}/include" \
DOXYGEN_TARGET_ARCH=${TARGET_ARCH} \
DOXYGEN_LINUX_PATH=${DOXYGEN_LINUX_PATH} \
NOTREVIEWED=${.CURDIR}/notreviewed.dox \
doxygen ${.CURDIR}/Doxyfile-${target}
@echo "API docs for ${target} are now available in ${.OBJDIR}/${target}/." | /usr/bin/fmt

14
tools/kerneldoc/subsys/notreviewed.dox Normal file
View File

@ -0,0 +1,14 @@
/* $FreeBSD$ */
/** @mainpage
* <b>IMPORTANT:</b> This API documentation may contain both functions which
* are public and functions that are for internal use only. Since we have not
* reviewed every part of the documentation yet, <i>some internal functions
* are not marked as such</i>. Until we finish reviewing the API documentation
* and add appropriate comments to functions which are only for internal use,
* you should take this into account. In case you want to use a function of
* this kernel subsystem in another kernel subsystem you should search for
* precedence of use outside this subsystem. If the function is not used
* outside this subsystem you should ask on the mailinglists about it, else
* you risk breaking something.
*/