diff options
author | Guillem Jover <guillem@debian.org> | 2009-10-09 15:41:54 +0200 |
---|---|---|
committer | Guillem Jover <guillem@debian.org> | 2009-10-26 05:19:56 +0100 |
commit | 876b5126314291cafba31bd4c341b95f777cf9fa (patch) | |
tree | 4a0712a7341c8402d8da101b92157339bf01da7e /doc/coding-style.txt | |
parent | 971e675a180c59642e2406acbb0c6f7bc68961e6 (diff) | |
download | dpkg-876b5126314291cafba31bd4c341b95f777cf9fa.tar.gz |
doc: Add doxygen support
The code should start getting switched to document using JavaDoc
style comments, at least for public declarations.
Diffstat (limited to 'doc/coding-style.txt')
-rw-r--r-- | doc/coding-style.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/coding-style.txt b/doc/coding-style.txt index 7ead2e077..6ef59984b 100644 --- a/doc/coding-style.txt +++ b/doc/coding-style.txt @@ -41,6 +41,11 @@ other changes to be done on them, oterwise we get unneeded fuzzies. <http://www.cl.cam.ac.uk/~mgk25/ucs/quotes.html> +Code documentation +~~~~~~~~~~~~~~~~~~ + +Public declarations should be documented using JavaDoc style comments. + Indentation, alignment and spacing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |