diff --git a/include/core/print.h b/include/core/print.h index a67d7310..bb7d3479 100644 --- a/include/core/print.h +++ b/include/core/print.h @@ -1,4 +1,5 @@ -/* +/** + * @file * Copyright (c) 2013 Anna Schumaker. */ #ifndef OCARINA_CORE_PRINT_H @@ -7,6 +8,12 @@ #include #include +/** + * Print a message to the console + * + * @param fmt Printf-style text format. + * @param ... Var-args to be printed. + */ inline void print(const char *fmt, ...) { va_list ap; @@ -26,6 +33,12 @@ inline void dprint(const char *fmt, ...) va_end(ap); } #else /* ! (CONFIG_DEBUG || CONFIG_TEST) */ +/** + * Print a message to the console (only if debugging is enabled). + * + * @param fmt Printf-style text format. + * @param ... Var-args to be printed. + */ inline void dprint(const char *fmt, ...) {} #endif /* CONFIG_DEBUG */