Author: allison
Date: Sat May 3 04:14:26 2008
New Revision: 27304
Modified:
trunk/docs/pdds/pdd28_strings.pod
Log:
[pdd] Strings PDD: fix a typo, move a few sections around.
Modified: trunk/docs/pdds/pdd28_strings.pod
==============================================================================
--- trunk/docs/pdds/pdd28_strings.pod (original)
+++ trunk/docs/pdds/pdd28_strings.pod Sat May 3 04:14:26 2008
@@ -9,7 +9,7 @@
This PDD describes the conventions for strings in Parrot,
including but not limited to support for multiple character sets,
-encodings and languages.
+encodings, and languages.
=head1 VERSION
@@ -355,18 +355,6 @@
characters in non-NFG strings). This conversion effectively uses an
intermediate NFG representation.
-=head2 String Subsystem
-
-The following functions are used internally to initialise and terminate the
-string allocation and garbage collection subsystem.
-
-=head3 Parrot_string_system_init (was string_init)
-
-Initialize Parrot's string subsystem.
-
-=head3 Parrot_string_system_end (was string_deinit)
-
-Terminate Parrot's string subsystem (clean up).
=head2 String Interface Functions
@@ -418,12 +406,6 @@
{{NOTE: the integer length isn't really necessary, and is under consideration
for deprecation.}}
-=head3 Parrot_constant_string_new (was const_string)
-
-Creates and returns a new Parrot constant string. Takes one C string (a C<char
-*>) as an argument, the value of the constant string. The length of the C
-string is calculated internally.
-
=head3 Parrot_string_new
Return a new string with the default encoding and character set. Accepts one
@@ -448,6 +430,12 @@
C<Parrot_find_encoding> and C<Parrot_find_charset> can be called to look up the
encoding or character set structs.}}
+=head3 Parrot_constant_string_new (was const_string)
+
+Creates and returns a new Parrot constant string. Takes one C string (a C<char
+*>) as an argument, the value of the constant string. The length of the C
+string is calculated internally.
+
=head3 Parrot_string_resize (was string_grow)
Resize the string buffer of the given string adding the number of bytes passed
@@ -550,9 +538,21 @@
modifying the original string.
-
=head2 Internal String Functions
+The following functions are used internally and are not part of the public
+interface.
+
+=head3 string_system_init (was string_init)
+
+Initialize Parrot's string subsystem, including string allocation and garbage
+collection.
+
+=head3 string_system_end (was string_deinit)
+
+Terminate Parrot's string subsystem (clean up), including string allocation and
+garbage collection.
+
=head3 string_max_bytes
Calculate the number of bytes needed to contain a given number of characters in
