diff options
author | netchild <netchild@FreeBSD.org> | 2006-05-28 15:25:18 +0000 |
---|---|---|
committer | netchild <netchild@FreeBSD.org> | 2006-05-28 15:25:18 +0000 |
commit | a13a275341ba58af1d15c4a955742f30713d338b (patch) | |
tree | 3397cf627973fd6fc58354bc9e8a7fea2d2325de /tools/kerneldoc/subsys/notreviewed.dox | |
parent | 531d197d819fca6835d6d1064ceb5c53c3851741 (diff) | |
download | FreeBSD-src-a13a275341ba58af1d15c4a955742f30713d338b.zip FreeBSD-src-a13a275341ba58af1d15c4a955742f30713d338b.tar.gz |
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>
Diffstat (limited to 'tools/kerneldoc/subsys/notreviewed.dox')
-rw-r--r-- | tools/kerneldoc/subsys/notreviewed.dox | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/tools/kerneldoc/subsys/notreviewed.dox b/tools/kerneldoc/subsys/notreviewed.dox new file mode 100644 index 0000000..bcc4bed --- /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. + */ |