Author: stas Date: Tue Dec 21 16:57:36 2004 New Revision: 123023 URL: http://svn.apache.org/viewcvs?view=rev&rev=123023 Log: the forgotten manpage: APR::UUID
Added: perl/modperl/docs/trunk/src/docs/2.0/api/APR/UUID.pod Modified: perl/modperl/docs/trunk/src/docs/2.0/api/config.cfg Added: perl/modperl/docs/trunk/src/docs/2.0/api/APR/UUID.pod Url: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/api/APR/UUID.pod?view=auto&rev=123023 ============================================================================== --- (empty file) +++ perl/modperl/docs/trunk/src/docs/2.0/api/APR/UUID.pod Tue Dec 21 16:57:36 2004 @@ -0,0 +1,148 @@ +=head1 NAME + +APR::UUID - Perl API for manipulating APR UUIDs + + + + +=head1 Synopsis + + use APR::UUID (); + + # get a random UUID and format it as a string + my $uuid = APR::UUID->new->format; + # $uuid = e.g. 'd48889bb-d11d-b211-8567-ec81968c93c6'; + + # same as the object returned by APR::UUID->new + my $uuid_parsed = APR::UUID->parse($uuid); + + +=head1 Description + +C<APR::UUID> is used to get and manipulate randow UUID. + +It allows you to C<L<create|/C_new_>> random UUID, which when +C<L<format|/C_format_>ted> returns a string like: + + 'd48889bb-d11d-b211-8567-ec81968c93c6'; + +which can be parsed back into the C<APR::UUID> object with +C<L<parse()|/C_parse_>>. + + + + + + + + + +=head1 API + +C<APR::UUID> provides the following functions and/or methods: + + + + + + +=head2 C<format> + +Convert an C<L<APR::UUID object|docs::2.0::api::APR::UUID>> object +into a string presentation: + + my $uuid_str = $uuid->format; + +=over 4 + +=item obj: C<$uuid> +( C<L<APR::UUID object|docs::2.0::api::APR::UUID>> ) + +=item ret: C<$uuid_str> + +returns a string representation of the object (.e.g +C<'d48889bb-d11d-b211-8567-ec81968c93c6'>). + +=item since: 1.99_12 + +=back + + + + + + +=head2 C<new> + +Create a C<L<APR::UUID object|docs::2.0::api::APR::UUID>> using the +random engine: + + my $uuid = APR::UUID->new; + +=over 4 + +=item class: C<APR::UUID> +( C<L<APR::UUID class|docs::2.0::api::APR::UUID>> ) + +=item ret: C<$uuid> +( C<L<APR::UUID object|docs::2.0::api::APR::UUID>> ) + +=item since: 1.99_12 + +=back + + + + + + + +=head2 C<parse> + +Convert a UUID string into an C<L<APR::UUID +object|docs::2.0::api::APR::UUID>> object: + + $uuid = APR::UUID->parse($uuid_str) + +=over 4 + +=item arg1: C<$uuid_str> (string) + +UUID string (.e.g C<'d48889bb-d11d-b211-8567-ec81968c93c6'>) + +=item ret: C<$uuid> +( C<L<APR::UUID object|docs::2.0::api::APR::UUID>> ) + +The new object. + +=item since: 1.99_12 + +=back + + + + + + +=head1 See Also + +L<mod_perl 2.0 documentation|docs::2.0::index>. + + + + +=head1 Copyright + +mod_perl 2.0 and its core modules are copyrighted under +The Apache Software License, Version 2.0. + + + + +=head1 Authors + +L<The mod_perl development team and numerous +contributors|about::contributors::people>. + +=cut + Modified: perl/modperl/docs/trunk/src/docs/2.0/api/config.cfg Url: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/api/config.cfg?view=diff&rev=123023&p1=perl/modperl/docs/trunk/src/docs/2.0/api/config.cfg&r1=123022&p2=perl/modperl/docs/trunk/src/docs/2.0/api/config.cfg&r2=123023 ============================================================================== --- perl/modperl/docs/trunk/src/docs/2.0/api/config.cfg (original) +++ perl/modperl/docs/trunk/src/docs/2.0/api/config.cfg Tue Dec 21 16:57:36 2004 @@ -65,6 +65,7 @@ APR/ThreadMutex.pod APR/URI.pod APR/Util.pod + APR/UUID.pod )], group => 'ModPerl::', --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]