Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

[doc] Improve the StructView docs a bit

  • Loading branch information...
commit 41da5a59ea306bf9075f874f8e2a3edd88470b1b 1 parent 767fc30
@leto leto authored
Showing with 10 additions and 4 deletions.
  1. +10 −4 src/pmc/structview.pmc
14 src/pmc/structview.pmc
@@ -1,9 +1,9 @@
-Copyright (C) 2001-2011, Parrot Foundation.
+Copyright (C) 2001-2012, Parrot Foundation.
=head1 NAME
-src/pmc/structview.pmc - C struct view for pointers.
+src/pmc/structview.pmc - View pointers as C structs
@@ -1120,7 +1120,7 @@ Implement the freeze/thaw API.
-=head2 Auxiliar functions
+=head2 Auxiliary functions
=over 4
@@ -1130,15 +1130,21 @@ Deallocation function to be attached to allocated instances.
=item C<static void dereference_null(PARROT_INTERP)>
+Throw an exception relating to attempting to derefence a NULL pointer.
=item C<static void index_out_of_bounds(PARROT_INTERP, INTVAL i)>
+Throw an exception about attempting to index outside the data.
=item C<static void buffer_too_small(PARROT_INTERP, size_t self_size, size_t
+Throw an exception about a buffer being too small.
=item C<static void dereference_unaligned(PARROT_INTERP, const void *base_ptr,
size_t align)>
-Throw the appropiate exception.
+Throw an exception relating to attempting to derefence an un-aligned pointer.

0 comments on commit 41da5a5

Please sign in to comment.
Something went wrong with that request. Please try again.