[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[or-cvs] a few minor cleanups to HACKING
Update of /home2/or/cvsroot/tor/doc
In directory moria:/home/arma/work/onion/cvs/tor/doc
Modified Files:
HACKING
Log Message:
a few minor cleanups to HACKING
Index: HACKING
===================================================================
RCS file: /home2/or/cvsroot/tor/doc/HACKING,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- HACKING 11 Jun 2005 06:07:43 -0000 1.15
+++ HACKING 16 Jun 2005 20:32:40 -0000 1.16
@@ -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.