summaryrefslogtreecommitdiff
path: root/docs/manual/developer/documenting
diff options
context:
space:
mode:
author(no author) <(no author)@unknown>2001-05-04 21:54:25 +0000
committer(no author) <(no author)@unknown>2001-05-04 21:54:25 +0000
commitad2dd84025f628d29200b5a9a41d654be678aa6f (patch)
tree35a838b6e9d6510a91e386728e78b4a81cb55781 /docs/manual/developer/documenting
parentf83672781de25207442ff908258219de1d103062 (diff)
downloadhttpd-RSE.tar.gz
This commit was manufactured by cvs2svn to create branch 'RSE'.RSE
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/RSE@88989 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/developer/documenting')
-rw-r--r--docs/manual/developer/documenting43
1 files changed, 0 insertions, 43 deletions
diff --git a/docs/manual/developer/documenting b/docs/manual/developer/documenting
deleted file mode 100644
index 0994b10d78..0000000000
--- a/docs/manual/developer/documenting
+++ /dev/null
@@ -1,43 +0,0 @@
-Apache 2.0 is using ScanDoc to document the API's and global variables in
-the code. This will explain the basics of how to document using Scandoc.
-
-To start a scandoc block, use /**
-To end a scandoc block, use */
-
-In the middle of the block, there are multiple tags we can use:
-
- Description of this functions purpose
- @param parameter_name description
- @tip Any information the programmer should know
- @deffunc function prototype.
-
-The deffunc is not always necessary. ScanDoc does not have a full parser in
-it, so any prototype that use a macro in the return type declaration is too
-complex for scandoc. Those functions require a deffunc.
-
-An example:
-
-/**
- * return the final element of the pathname
- * @param pathname The path to get the final element of
- * @return the final element of the path
- * @tip Examples:
- * <PRE>
- * "/foo/bar/gum" -> "gum"
- * "/foo/bar/gum/" -> ""
- * "gum" -> "gum"
- * "wi\\n32\\stuff" -> "stuff"
- * </PRE>
- * @deffunc const char * ap_filename_of_pathname(const char *pathname)
- */
-
-At the top of the header file, we always include
-
-/**
- * @package Name of library header
- */
-
-ScanDoc uses a new html file for each package. The html files are named:
-
-Name of library header.html, so try to be concise with your names
-