From 6adbf2d5fccaa682fbb2343e5889f42e8bc922cf Mon Sep 17 00:00:00 2001
From: Anna Schumaker <Anna@OcarinaProject.net>
Date: Sat, 13 Sep 2014 10:07:23 -0400
Subject: [PATCH] Add doxygen comments to print.h

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
---
 include/core/print.h | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

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 <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 */