Diff: debug.h

Revision:

69:65665afbad5d

Parent:

48:195c97f12e8e

Child:

72:895ca792c647

--- a/debug.h	Fri Nov 07 17:57:55 2014 +0000
+++ b/debug.h	Wed Nov 12 13:25:54 2014 +0000
@@ -1,3 +1,10 @@
+/**
+ * @file debug.h
+ * @Synopsis Instrumenta o uso de debug no código da header.
+ * @author Jhonatan Casale / PedroZN
+ * @version 1
+ * @date 2014-11-05
+ */
 #ifndef __DEBUG_H__
 #define __DEBUG_H__
 
@@ -9,9 +16,18 @@
 #include "prompt.h"
 
 extern char debug_msg1[ 1024+64 ];
+///< Buffer usado na composisão da mensagem enviada pela macro debug_msg
 extern char debug_msg2[ 1024 ];
+///< Buffer usado na composisão da mensagem enviada pela macro debug_msg
 extern char msg_[ 1024 ];
+///< Buffer utilizado pela macro send_msg
 
+/**
+ * @Synopsis Função usada anteriormente para formatação da string que debug, não esta mais em uso.
+ *
+ * @param size Tamanho do pacote que deve ser enviado.
+ * @param pkg Ponteiro para inicio dos dados a serem transmitidos.
+ */
 void debug_pkg( int size, uint8_t * pkg );
 
 #define debug_msg(...) _debug_msg(__VA_ARGS__)