Add doxygen comments to print.h
Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
This commit is contained in:
parent
ad48ac7d16
commit
6adbf2d5fc
|
@ -1,4 +1,5 @@
|
|||
/*
|
||||
/**
|
||||
* @file
|
||||
* Copyright (c) 2013 Anna Schumaker.
|
||||
*/
|
||||
#ifndef OCARINA_CORE_PRINT_H
|
||||
|
@ -7,6 +8,12 @@
|
|||
#include <cstdio>
|
||||
#include <cstdarg>
|
||||
|
||||
/**
|
||||
* 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 */
|
||||
|
||||
|
|
Loading…
Reference in New Issue