Simon Ford / debug

Dependents:   pyrocommander Projektni_zadatak_Analogni_sat ProjetOctopode

Files at this revision

API Documentation at this revision

Comitter:
simon
Date:
Sat Aug 04 21:59:29 2012 +0000
Parent:
0:aa1c8e69d98f
Child:
2:24afdea2d903
Commit message:
Add basic doxygen api documentation

Changed in this revision

debug.h Show annotated file Show diff for this revision Revisions of this file
--- a/debug.h	Sat Aug 04 21:04:21 2012 +0000
+++ b/debug.h	Sat Aug 04 21:59:29 2012 +0000
@@ -24,6 +24,10 @@
 #include <stdarg.h>
 #include <stdio.h>
 
+/** Output a debug message
+ * 
+ * @param format printf-style format string, followed by variables
+ */
 static inline void debug(const char *format, ...) {
     va_list args;
     va_start(args, format);
@@ -31,6 +35,11 @@
     va_end(args);
 }
 
+/** Conditionally output a debug message
+ * 
+ * @param condition output only if condition is true
+ * @param format printf-style format string, followed by variables
+ */
 static inline void debug(bool condition, const char *format, ...) {
     if(condition) {
         va_list args;