summaryrefslogtreecommitdiff
path: root/tools/kerneldoc
diff options
context:
space:
mode:
authorAlexander Leidinger <netchild@FreeBSD.org>2006-05-28 15:25:18 +0000
committerAlexander Leidinger <netchild@FreeBSD.org>2006-05-28 15:25:18 +0000
commit39e2bd0bdb4ef0be4280881e9aa79c15e3b6e166 (patch)
tree3397cf627973fd6fc58354bc9e8a7fea2d2325de /tools/kerneldoc
parent451651c72ed5b6d0a2c5cdca44ad526baf050ad7 (diff)
downloadsrc-test-39e2bd0bdb4ef0be4280881e9aa79c15e3b6e166.tar.gz
src-test-39e2bd0bdb4ef0be4280881e9aa79c15e3b6e166.zip
Add a disclaimer regarding public/internal functions to every subsystem for
now. Discussed on: cvs-all Helped with the wording: "Ben Kaduk" <minimarmot@gmail.com>
Notes
Notes: svn path=/head/; revision=159010
Diffstat (limited to 'tools/kerneldoc')
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-cam2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-crypto2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-dev_pci3
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-dev_sound2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-dev_usb2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-geom2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-i4b2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-kern2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-libkern2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-linux3
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-net802112
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-netgraph2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-netinet2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-netinet62
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-netipsec2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-opencrypto2
-rw-r--r--tools/kerneldoc/subsys/Doxyfile-vm2
-rw-r--r--tools/kerneldoc/subsys/Makefile1
-rw-r--r--tools/kerneldoc/subsys/notreviewed.dox14
19 files changed, 34 insertions, 17 deletions
diff --git a/tools/kerneldoc/subsys/Doxyfile-cam b/tools/kerneldoc/subsys/Doxyfile-cam
index 55e7771107869..006cdcb12ddbe 100644
--- a/tools/kerneldoc/subsys/Doxyfile-cam
+++ b/tools/kerneldoc/subsys/Doxyfile-cam
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-crypto b/tools/kerneldoc/subsys/Doxyfile-crypto
index 4eadf59f05c50..f3e6c5a7c0829 100644
--- a/tools/kerneldoc/subsys/Doxyfile-crypto
+++ b/tools/kerneldoc/subsys/Doxyfile-crypto
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-dev_pci b/tools/kerneldoc/subsys/Doxyfile-dev_pci
index 9690796162f87..d8d91a7ca9c2e 100644
--- a/tools/kerneldoc/subsys/Doxyfile-dev_pci
+++ b/tools/kerneldoc/subsys/Doxyfile-dev_pci
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-dev_sound b/tools/kerneldoc/subsys/Doxyfile-dev_sound
index 430960e3dba08..5a55398759e79 100644
--- a/tools/kerneldoc/subsys/Doxyfile-dev_sound
+++ b/tools/kerneldoc/subsys/Doxyfile-dev_sound
@@ -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 \
diff --git a/tools/kerneldoc/subsys/Doxyfile-dev_usb b/tools/kerneldoc/subsys/Doxyfile-dev_usb
index 7a05dfa636563..731a018d82ebc 100644
--- a/tools/kerneldoc/subsys/Doxyfile-dev_usb
+++ b/tools/kerneldoc/subsys/Doxyfile-dev_usb
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-geom b/tools/kerneldoc/subsys/Doxyfile-geom
index 30c9c0c6470f3..374665f3f6eb7 100644
--- a/tools/kerneldoc/subsys/Doxyfile-geom
+++ b/tools/kerneldoc/subsys/Doxyfile-geom
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-i4b b/tools/kerneldoc/subsys/Doxyfile-i4b
index 0a3251ea63c7e..5573e840a9d16 100644
--- a/tools/kerneldoc/subsys/Doxyfile-i4b
+++ b/tools/kerneldoc/subsys/Doxyfile-i4b
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-kern b/tools/kerneldoc/subsys/Doxyfile-kern
index b2ba51f4d6cd1..5857465d76add 100644
--- a/tools/kerneldoc/subsys/Doxyfile-kern
+++ b/tools/kerneldoc/subsys/Doxyfile-kern
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-libkern b/tools/kerneldoc/subsys/Doxyfile-libkern
index 5191c9e4f8476..42c53de0d9dc5 100644
--- a/tools/kerneldoc/subsys/Doxyfile-libkern
+++ b/tools/kerneldoc/subsys/Doxyfile-libkern
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-linux b/tools/kerneldoc/subsys/Doxyfile-linux
index 8de57f3e87938..3f21047944449 100644
--- a/tools/kerneldoc/subsys/Doxyfile-linux
+++ b/tools/kerneldoc/subsys/Doxyfile-linux
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-net80211 b/tools/kerneldoc/subsys/Doxyfile-net80211
index 75ada2563248d..869f06b4af7a0 100644
--- a/tools/kerneldoc/subsys/Doxyfile-net80211
+++ b/tools/kerneldoc/subsys/Doxyfile-net80211
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-netgraph b/tools/kerneldoc/subsys/Doxyfile-netgraph
index b203e680662ba..5641cb08bf9dd 100644
--- a/tools/kerneldoc/subsys/Doxyfile-netgraph
+++ b/tools/kerneldoc/subsys/Doxyfile-netgraph
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-netinet b/tools/kerneldoc/subsys/Doxyfile-netinet
index c5c91dcd1f779..7fedb3db11b48 100644
--- a/tools/kerneldoc/subsys/Doxyfile-netinet
+++ b/tools/kerneldoc/subsys/Doxyfile-netinet
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-netinet6 b/tools/kerneldoc/subsys/Doxyfile-netinet6
index 57c0f8ce773d3..2f902d3a00c20 100644
--- a/tools/kerneldoc/subsys/Doxyfile-netinet6
+++ b/tools/kerneldoc/subsys/Doxyfile-netinet6
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-netipsec b/tools/kerneldoc/subsys/Doxyfile-netipsec
index b962e2cc4e1d9..b7038f2440c8d 100644
--- a/tools/kerneldoc/subsys/Doxyfile-netipsec
+++ b/tools/kerneldoc/subsys/Doxyfile-netipsec
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-opencrypto b/tools/kerneldoc/subsys/Doxyfile-opencrypto
index c14a59f4f548c..33f1654d9d862 100644
--- a/tools/kerneldoc/subsys/Doxyfile-opencrypto
+++ b/tools/kerneldoc/subsys/Doxyfile-opencrypto
@@ -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
diff --git a/tools/kerneldoc/subsys/Doxyfile-vm b/tools/kerneldoc/subsys/Doxyfile-vm
index c232997743c02..22bb8c56cc9a0 100644
--- a/tools/kerneldoc/subsys/Doxyfile-vm
+++ b/tools/kerneldoc/subsys/Doxyfile-vm
@@ -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
diff --git a/tools/kerneldoc/subsys/Makefile b/tools/kerneldoc/subsys/Makefile
index 35aed6c103a27..ab6f987ff54b0 100644
--- a/tools/kerneldoc/subsys/Makefile
+++ b/tools/kerneldoc/subsys/Makefile
@@ -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
diff --git a/tools/kerneldoc/subsys/notreviewed.dox b/tools/kerneldoc/subsys/notreviewed.dox
new file mode 100644
index 0000000000000..bcc4bed1f61a8
--- /dev/null
+++ b/tools/kerneldoc/subsys/notreviewed.dox
@@ -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.
+ */
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-14 02:26:00 +0000