Inline docs update

git-svn-id: https://svn.parrot.org/parrot/trunk@5155 d31e2699-5ff4-0310-a27c-f18f2fbe73fe

src/cpu_dep.c

@@ -1,14 +1,30 @@
-/* cpu_dep.c
- *  Copyright: 2001-2003 The Perl Foundation.  All Rights Reserved.
- *  CVS Info
- *     $Id$
- *  Overview:
- *     CPU dependent functions
- *  Data Structure and Algorithms:
- *  History:
- *  Notes:
- *  References:
- */
+/*
+Copyright: 2001-2003 The Perl Foundation.  All Rights Reserved.
+$Id$
+
+=head1 NAME
+
+src/cpu_dep.c - CPU-dependent functions
+
+=head1 DESCRIPTION
+
+These functions are called while stackwalking during dead object
+destruction. They implement conditional CPU-specific behaviour related
+to register windowing.
+
+Register windowing is a technique which avoids having to empty registers
+by moving a virtual window up/down the register stack restricting the
+number of registers which are visible.
+
+Remember you read somethng about it in F<docs/infant.dev>?
+
+=head2 Functions
+
+=over 4
+
+=cut
+
+*/
 
 #include "parrot/parrot.h"
 
@@ -22,6 +38,16 @@ extern void *flush_reg_store(void);
 
 static void trace_system_stack(struct Parrot_Interp *interpreter);
 
+/*
+
+=item C<void trace_system_areas(struct Parrot_Interp *interpreter)>
+
+Traces the system stack and any additional CPU-specific areas.
+
+=cut
+
+*/
+
 void
 trace_system_areas(struct Parrot_Interp *interpreter)
 {
@@ -72,6 +98,17 @@ trace_system_areas(struct Parrot_Interp *interpreter)
     trace_system_stack(interpreter);
 }
 
+/*
+
+=item C<static void
+trace_system_stack(struct Parrot_Interp *interpreter)>
+
+Traces the memory block starting at C<<interpreter->lo_var_ptr>>.
+
+=cut
+
+*/
+
 static void
 trace_system_stack(struct Parrot_Interp *interpreter)
 {
@@ -81,6 +118,18 @@ trace_system_stack(struct Parrot_Interp *interpreter)
 			   (size_t)&lo_var_ptr);
 }
 
+/*
+
+=back
+
+=head1 SEE ALSO
+
+F<src/dod.c>, F<include/parrot/dod.h> and F<docs/infant.dev>.
+
+=cut
+
+*/
+
 /*
  * Local variables:
  * c-indentation-style: bsd

src/datatypes.c

@@ -1,18 +1,39 @@
 /*
- * datatypes.c
- *  Copyright: (c) 2002 Leopold Toetsch <lt@toetsch.at>
- *  License:  Artistic/GPL, see README and LICENSES for details
- *  CVS Info
- *     $Id$
- *  Overview:
- *     Parrot and native data types functions.
- */
+Copyright: (c) 2002 Leopold Toetsch <lt@toetsch.at>
+License:  Artistic/GPL, see README and LICENSES for details
+$Id$
+
+=head1 NAME
+
+src/datatypes.c - Parrot and native data types functions
+
+=head1 DESCRIPTION
+
+The functions in this file are used in .ops files to access the C<enum>
+and C string constants for Parrot and native data types defined iin
+F<include/parrot/datatypes.h>.
+
+=head2 Functions
+
+=over 4
+
+=cut
+
+*/
 
 #include "parrot/parrot.h"
 
-/*=for api Parrot_get_datatype_enum
- * return datatype enum for STRING* typename
- */
+/*
+
+=item C<INTVAL
+Parrot_get_datatype_enum(Interp *interpreter, STRING *typename)>
+
+Return datatype C<enum> for C<STRING*> typename.
+
+=cut
+
+*/
+
 INTVAL
 Parrot_get_datatype_enum(Interp *interpreter, STRING *typename)
 {
@@ -29,9 +50,17 @@ Parrot_get_datatype_enum(Interp *interpreter, STRING *typename)
     return enum_type_undef;
 }
 
-/*=for api Parrot_get_datatype_name
- * return datatype name for type
- */
+/*
+
+=item C<STRING *
+Parrot_get_datatype_name(Interp *interpreter, INTVAL type)>
+
+Return datatype name for C<type>.
+
+=cut
+
+*/
+
 STRING *
 Parrot_get_datatype_name(Interp *interpreter, INTVAL type)
 {
@@ -43,6 +72,18 @@ Parrot_get_datatype_name(Interp *interpreter, INTVAL type)
     return string_make(interpreter, s, strlen(s), 0, PObj_external_FLAG, 0);
 }
 
+/*
+
+=back
+
+=head1 SEE ALSO
+
+F<include/parrot/datatypes.h>.
+
+=cut
+
+*/
+
 /*
  * Local variables:
  * c-indentation-style: bsd