aboutsummaryrefslogtreecommitdiff
path: root/doc/HACKING
diff options
context:
space:
mode:
authorRoger Dingledine <arma@torproject.org>2005-06-16 20:32:40 +0000
committerRoger Dingledine <arma@torproject.org>2005-06-16 20:32:40 +0000
commit5c85d974965d65620bd6eca1b09108d52438cc11 (patch)
tree86331d6fdac0888664e5eea23899ce778ea3122e /doc/HACKING
parentcc9b0c7b7be1ee1a17ac0c48eef9eb6da545d05e (diff)
downloadtor-5c85d974965d65620bd6eca1b09108d52438cc11.tar
tor-5c85d974965d65620bd6eca1b09108d52438cc11.tar.gz
a few minor cleanups to HACKING
svn:r4438
Diffstat (limited to 'doc/HACKING')
-rw-r--r--doc/HACKING6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/HACKING b/doc/HACKING
index f912e0f82..23253cb34 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -66,8 +66,8 @@
1. Begin every file that should be documented with
/**
* \file filename.c
- * \brief Short desccription of the file
- */
+ * \brief Short desccription of the file.
+ **/
(Doxygen will recognize any comment beginning with /** as special.)
@@ -106,7 +106,7 @@
$ doxygen -g
To generate a file called 'Doxyfile'. Edit that file and run 'doxygen' to
- generate the aPI documentation.
+ generate the API documentation.
6. See the Doxygen manual for more information; this summary just scratches
the surface.