[svn:parrot] r43987 - in trunk: src t/codingstd

[cotto at svn.parrot.org]

Author: cotto
Date: Tue Feb 16 08:05:47 2010
New Revision: 43987
URL: https://trac.parrot.org/parrot/changeset/43987

Log:
[docs] document some internal debugger functions (no functional changes)

Modified:
   trunk/src/debug.c
   trunk/t/codingstd/c_function_docs.t

Modified: trunk/src/debug.c
==============================================================================
--- trunk/src/debug.c	Tue Feb 16 04:55:52 2010	(r43986)
+++ trunk/src/debug.c	Tue Feb 16 08:05:47 2010	(r43987)
@@ -603,6 +603,9 @@
 
 =item C<static const DebuggerCmd * get_cmd(const char **cmd)>
 
+Parse the debuggger command indicated by C<**cmd>.  Return a pointer to the
+matching function for known commands, or a NULL pointer otherwise.
+
 =cut
 
 */
@@ -658,6 +661,8 @@
 
 =item C<static const char * skip_whitespace(const char *cmd)>
 
+Return a pointer to the first non-whitespace character in C<cmd>.
+
 =cut
 
 */
@@ -677,6 +682,8 @@
 
 =item C<static unsigned long get_uint(const char **cmd, unsigned int def)>
 
+Get an unsigned int from C<**cmd>.
+
 =cut
 
 */
@@ -700,6 +707,8 @@
 
 =item C<static unsigned long get_ulong(const char **cmd, unsigned long def)>
 
+Get an unsigned long from C<**cmd>.
+
 =cut
 
 */
@@ -1500,6 +1509,8 @@
 
 =item C<static unsigned short condition_regtype(const char *cmd)>
 
+Return the type of the register represented by C<*cmd>.
+
 =cut
 
 */
@@ -1865,6 +1876,8 @@
 
 =item C<static void list_breakpoints(PDB_t *pdb)>
 
+Print all breakpoints for this debugger session to C<pdb->debugger>.
+
 =cut
 
 */

Modified: trunk/t/codingstd/c_function_docs.t
==============================================================================
--- trunk/t/codingstd/c_function_docs.t	Tue Feb 16 04:55:52 2010	(r43986)
+++ trunk/t/codingstd/c_function_docs.t	Tue Feb 16 08:05:47 2010	(r43987)
@@ -121,7 +121,6 @@
 examples/c/pbc_info.c
 examples/compilers/japhc.c
 src/atomic/gcc_x86.c
-src/debug.c
 src/gc/generational_ms.c
 src/io/io_string.c
 src/string/charset/ascii.c