diff options
38 files changed, 68 insertions, 34 deletions
diff --git a/sys/doc/subsys/Doxyfile-cam b/sys/doc/subsys/Doxyfile-cam index 55e777110786..006cdcb12ddb 100644 --- a/sys/doc/subsys/Doxyfile-cam +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-crypto b/sys/doc/subsys/Doxyfile-crypto index 4eadf59f05c5..f3e6c5a7c082 100644 --- a/sys/doc/subsys/Doxyfile-crypto +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-dev_pci b/sys/doc/subsys/Doxyfile-dev_pci index 9690796162f8..d8d91a7ca9c2 100644 --- a/sys/doc/subsys/Doxyfile-dev_pci +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-dev_sound b/sys/doc/subsys/Doxyfile-dev_sound index 430960e3dba0..5a55398759e7 100644 --- a/sys/doc/subsys/Doxyfile-dev_sound +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-dev_usb b/sys/doc/subsys/Doxyfile-dev_usb index 7a05dfa63656..731a018d82eb 100644 --- a/sys/doc/subsys/Doxyfile-dev_usb +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-geom b/sys/doc/subsys/Doxyfile-geom index 30c9c0c6470f..374665f3f6eb 100644 --- a/sys/doc/subsys/Doxyfile-geom +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-i4b b/sys/doc/subsys/Doxyfile-i4b index 0a3251ea63c7..5573e840a9d1 100644 --- a/sys/doc/subsys/Doxyfile-i4b +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-kern b/sys/doc/subsys/Doxyfile-kern index b2ba51f4d6cd..5857465d76ad 100644 --- a/sys/doc/subsys/Doxyfile-kern +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-libkern b/sys/doc/subsys/Doxyfile-libkern index 5191c9e4f847..42c53de0d9dc 100644 --- a/sys/doc/subsys/Doxyfile-libkern +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-linux b/sys/doc/subsys/Doxyfile-linux index 8de57f3e8793..3f2104794444 100644 --- a/sys/doc/subsys/Doxyfile-linux +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-net80211 b/sys/doc/subsys/Doxyfile-net80211 index 75ada2563248..869f06b4af7a 100644 --- a/sys/doc/subsys/Doxyfile-net80211 +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-netgraph b/sys/doc/subsys/Doxyfile-netgraph index b203e680662b..5641cb08bf9d 100644 --- a/sys/doc/subsys/Doxyfile-netgraph +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-netinet b/sys/doc/subsys/Doxyfile-netinet index c5c91dcd1f77..7fedb3db11b4 100644 --- a/sys/doc/subsys/Doxyfile-netinet +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-netinet6 b/sys/doc/subsys/Doxyfile-netinet6 index 57c0f8ce773d..2f902d3a00c2 100644 --- a/sys/doc/subsys/Doxyfile-netinet6 +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-netipsec b/sys/doc/subsys/Doxyfile-netipsec index b962e2cc4e1d..b7038f2440c8 100644 --- a/sys/doc/subsys/Doxyfile-netipsec +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-opencrypto b/sys/doc/subsys/Doxyfile-opencrypto index c14a59f4f548..33f1654d9d86 100644 --- a/sys/doc/subsys/Doxyfile-opencrypto +++ b/sys/doc/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/sys/doc/subsys/Doxyfile-vm b/sys/doc/subsys/Doxyfile-vm index c232997743c0..22bb8c56cc9a 100644 --- a/sys/doc/subsys/Doxyfile-vm +++ b/sys/doc/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/sys/doc/subsys/Makefile b/sys/doc/subsys/Makefile index 35aed6c103a2..ab6f987ff54b 100644 --- a/sys/doc/subsys/Makefile +++ b/sys/doc/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/sys/doc/subsys/notreviewed.dox b/sys/doc/subsys/notreviewed.dox new file mode 100644 index 000000000000..bcc4bed1f61a --- /dev/null +++ b/sys/doc/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. + */ diff --git a/tools/kerneldoc/subsys/Doxyfile-cam b/tools/kerneldoc/subsys/Doxyfile-cam index 55e777110786..006cdcb12ddb 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 4eadf59f05c5..f3e6c5a7c082 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 9690796162f8..d8d91a7ca9c2 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 430960e3dba0..5a55398759e7 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 7a05dfa63656..731a018d82eb 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 30c9c0c6470f..374665f3f6eb 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 0a3251ea63c7..5573e840a9d1 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 b2ba51f4d6cd..5857465d76ad 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 5191c9e4f847..42c53de0d9dc 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 8de57f3e8793..3f2104794444 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 75ada2563248..869f06b4af7a 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 b203e680662b..5641cb08bf9d 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 c5c91dcd1f77..7fedb3db11b4 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 57c0f8ce773d..2f902d3a00c2 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 b962e2cc4e1d..b7038f2440c8 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 c14a59f4f548..33f1654d9d86 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 c232997743c0..22bb8c56cc9a 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 35aed6c103a2..ab6f987ff54b 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 000000000000..bcc4bed1f61a --- /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. + */ |