a few minor cleanups to HACKING

svn:r4438
This commit is contained in:
Roger Dingledine 2005-06-16 20:32:40 +00:00
parent cc9b0c7b7b
commit 5c85d97496

View File

@ -66,8 +66,8 @@
1. Begin every file that should be documented with 1. Begin every file that should be documented with
/** /**
* \file filename.c * \file filename.c
* \brief Short desccription of the file * \brief Short desccription of the file.
*/ **/
(Doxygen will recognize any comment beginning with /** as special.) (Doxygen will recognize any comment beginning with /** as special.)
@ -106,7 +106,7 @@
$ doxygen -g $ doxygen -g
To generate a file called 'Doxyfile'. Edit that file and run 'doxygen' to 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 6. See the Doxygen manual for more information; this summary just scratches
the surface. the surface.