docs: make a note of doxygen usage in HACKING

About all we can do to encourage consistency. Fixes Github issue #256
2016-08-18 23:01:25 +00:00 · 2016-08-18 23:01:25 +00:00 · 99a79c7a53
parent 13d430268a
commit 99a79c7a53
1 changed files with 3 additions and 0 deletions
--- a/3
+++ b/3
@ -66,6 +66,9 @@ Development guidelines

 - For examples on using libopencm3 see the libopencm3-examples repository.

+ - Doxygen is used to generate API docs, please follow that style for function
+   and definition commentary where possible.
+
 Tips and tricks
 ---------------