Doxygen pretty much everything

Author: mateoconlechuga

CEdev/include/lib/ce/debug.h

@@ -1,120 +1,77 @@
 /**
- * @file C DEBUGGING LIBRARY
- * @version 3
- *
- * @section LICENSE
- *
- * Copyright (c) 2016
- * Matthew "MateoConLechuga" Waltz
- * All rights reserved.
- * 
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- * 
- * * Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- * 
- * * Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- * 
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * @section DESCRIPTION
- *
- * This library implements some some useful debugging functions
+ * @file
+ * @author Matt "MateoConLechuga" Waltz
+ * @brief Contains useful debugging features for use with the integrated CEmu debugger
  */
 
 /**
- * @brief Use dbg_sprintf(dbgout, const char*, ...); to print to the emulator console. See the syntax for 'printf' for more information
+ * @fn void dbg_sprintf(out, const char*, ...)
+ * @brief Use to print to the emulator console. See the syntax for 'printf' for more information
  * @param out can be dbgout (black) or dbgerr (red)
- *
- * void dbg_sprintf(out, const char*, ...);
  */
 
 /**
+ * @fn void dbg_Debugger(void);
  * @brief Opens the debugger
- *
- * void dbg_Debugger(void);
  */
 
 /**
- * @brief Sets a breakpoint at a particualr address in an emulator
+ * @fn void dbg_SetBreakpoint(void *address)
+ * @brief Sets a breakpoint at a particular address in an emulator
  * @param address is the address of the breakpoint to set
- *
- * void dbg_SetBreakpoint(void *address);
  */
 
 /**
- * @brief Removes a breakpoint at a particualr address in an emulator
+ * @fn void dbg_RemoveBreakpoint(void *address)
+ * @brief Removes a breakpoint at a particular address in an emulator
  * @param address is the address of the breakpoint to remove
- *
- * void dbg_RemoveBreakpoint(void *address);
  */
 
 /**
- * @brief Sets a non-breaking watchpoint at a particualr address in an emulator
+ * @fn void dbg_SetWatchpoint(void *address, unsigned length)
+ * @brief Sets a non-breaking watchpoint at a particular address in an emulator
  * @param address is the address of the watchpoint to set
  * @param length is the size of the data at the address (values 1-4)
- *
- * void dbg_SetWatchpoint(void *address, unsigned length);
  */
 
 /**
- * @brief Sets a read watchpoint at a particualr address in an emulator
+ * @fn void dbg_SetReadWatchpoint(void *address, unsigned length)
+ * @brief Sets a read watchpoint at a particular address in an emulator
  * @param address is the address of the watchpoint to set
  * @param length is the size of the data at the address (values 1-4)
- *
- * void dbg_SetReadWatchpoint(void *address, unsigned length);
  */
 
 /**
- * @brief Sets a write watchpoint at a particualr address in an emulator
+ * @fn void dbg_SetWriteWatchpoint(void *address, unsigned length)
+ * @brief Sets a write watchpoint at a particular address in an emulator
  * @param address is the address of the watchpoint to set
  * @param length is the size of the data at the address (values 1-4)
- *
- * void dbg_SetWriteWatchpoint(void *address, unsigned length);
  */
 
 /**
- * @brief Sets a read and write watchpoint at a particualr address in an emulator
+ * @fn void dbg_SetReadWriteWatchpoint(void *address, unsigned length)
+ * @brief Sets a read and write watchpoint at a particular address in an emulator
  * @param address is the address of the watchpoint to set
  * @param length is the size of the data at the address (values 1-4)
- *
- * void dbg_SetReadWriteWatchpoint(void *address, unsigned length);
  */
 
 /**
- * @brief Removes a watchpoint at a particualr address in an emulator
+ * @fn void dbg_RemoveWatchpoint(void *address)
+ * @brief Removes a watchpoint at a particular address in an emulator
  * @param address is the address of the watchpoint to remove
- *
- * void dbg_RemoveWatchpoint(void *address);
  */
 
 /**
+ * @fn void dbg_RemoveAllBreakpoints(void)
  * @brief Removes all breakpoints in an emulator
- *
- * void dbg_RemoveAllBreakpoints(void);
  */
 
 /**
+ * @fn void dbg_RemoveAllWatchpoints(void)
  * @brief Removes all watchpoints in an emulator
- *
- * void dbg_RemoveAllWatchpoints(void);
  */
 
-/**
- * Preprocessor definitions (should not be looked at :P)
- */
+/* Preprocessor definitions (should not be looked at :P) */
 #ifdef dbg_Debugger
 #undef dbg_Debugger
 #endif
@@ -197,9 +154,7 @@
 #define dbgerr (NULL)
 #endif
 
-/**
- * simple function prototypes (should not ever be used or even looked at)
- */
+/* simple function prototypes (should not ever be used or even looked at) */
 void SetBreakpoint(void *address);
 void RemoveBreakpoint(void *address);
 void SetWatchpoint(void *address, unsigned length);

CEdev/include/lib/ce/decompress.h

@@ -1,13 +1,25 @@
+/**
+ * @file
+ * @author Matt "MateoConLechuga" Waltz
+ * @brief Optimized decompression routines
+ */
+
 #ifndef DECOMPRESS_H
 #define DECOMPRESS_H
 
 /**
  * Decompress a block of zx7 encoded data
+ *
+ * @param src Pointer to compressed source block
+ * @param dst Pointer to destination block
  */
 void dzx7_Standard(void *src, void *dst);
 
 /**
  * Decompress a block of zx7 encoded data fast
+ *
+ * @param src Pointer to compressed source block
+ * @param dst Pointer to destination block
  */
 void dzx7_Turbo(void *src, void *dst);