[perl-ldap-checkins] CVS: ldap/lib/Net/LDAP Message.pod,1.7,1.8

[Chris R. <chr...@us...>]

Update of /cvsroot/perl-ldap/ldap/lib/Net/LDAP
In directory sc8-pr-cvs1:/tmp/cvs-serv14432

Modified Files:
	Message.pod 
Log Message:
Updated documentation style.

Index: Message.pod
===================================================================
RCS file: /cvsroot/perl-ldap/ldap/lib/Net/LDAP/Message.pod,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- Message.pod	20 May 2003 14:56:04 -0000	1.7
+++ Message.pod	1 Aug 2003 18:42:47 -0000	1.8
@@ -4,7 +4,7 @@
 
 =head1 SYNOPSIS
 
-  use Net::LDAP;
+ use Net::LDAP;
 
 =head1 DESCRIPTION
 
@@ -20,80 +20,85 @@
 L<search|Net::LDAP/item_search> and
 L<unbind|Net::LDAP/item_unbind>.
 
-The sub-class L<Net::LDAP::Search> returned by L<search|Net::LDAP/item_search> also
-defines many methods.
+The sub-class L<Net::LDAP::Search> returned by
+L<search|Net::LDAP/item_search> also defines many methods.
 
-If the L<Net::LDAP> object is in async mode then all these methods, except
-C<done>, will cause a wait until the request is completed.
+If the L<Net::LDAP> object is in async mode then all these methods,
+except C<done>, will cause a wait until the request is completed.
 
 =head1 METHODS
 
 =over 4
 
-=item code
+=item code ( )
 
-The code value in the result message from the server. Normally for
-a success zero will be returned. Constants for the result codes
-can be imported from the L<Net::LDAP> or L<Net::LDAP::Constant> module.
+The code value in the result message from the server. Normally for a
+success zero will be returned. Constants for the result codes can be
+imported from the L<Net::LDAP> or L<Net::LDAP::Constant> module.
 
-=item control [ OID ]
+=item control ( )
 
-Return a list of controls returned from the server. If OID is given
-then only controls with type equal to OID will be returned.
+Return a list of controls that were returned from the server.
 
-=item dn
+=item control ( OID, ... )
+
+Return a list of controls with the given OIDs that were returned from
+the server.
+
+=item dn ( )
 
 The DN in the result message from the server.
 
-=item done
+=item done ( )
 
 Returns I<true> if the request has been completed.
 
-=item error
+=item error ( )
 
 Returns the error message in the result message from the server. If
 the server did not include an error message, then the result of
 L<ldap_error_desc|Net::LDAP::Util/ldap_error_desc> with the error code
 from the result message.
 
-=item error_name
+=item error_name ( )
 
 Returns the name of the error code in the result message from the
 server. See L<ldap_error_name|Net::LDAP::Util::ldap_error_name> for a
 detailed description of the return value.
 
-=item error_text
+=item error_text ( )
 
 Returns the short text description of the error code in the result
 message from the server. See
 L<ldap_error_text|Net::LDAP::Util::ldap_error_text> for a detailed
 description of the return value.
 
-=item error_desc
+=item error_desc ( )
 
 Returns a long text description of the error code in the result
 message from the server. See
 L<ldap_error_desc|Net::LDAP::Util::ldap_error_desc> for a detailed
 description of the return value.
 
-=item is_error
+=item is_error ( )
 
-Returns I<true> if the result code is considered to be an error for the operation.
+Returns I<true> if the result code is considered to be an error for
+the operation.
 
-=item mesg_id
+=item mesg_id ( )
 
 The message id of the request message sent to the server.
 
-=item referrals
+=item referrals ( )
 
 Returns a list of referrals from the result message.
 
-=item server_error
+=item server_error ( )
 
-The error message returned by the server, or undef if the server did not provide
-a message.
+The error message returned by the server, or C<undef> if the server
+did not provide a message.
 
-=item sync
+=item sync ( )
 
 Wait for the server to complete the request.
 
@@ -108,21 +113,21 @@
 
 =head1 ACKNOWLEDGEMENTS
 
-This document is based on a document originally written by Russell Fulton
-E<lt>r.f...@au...E<gt>.
+This document is based on a document originally written by Russell
+Fulton E<lt>r.f...@au...E<gt>.
 
 =head1 AUTHOR
 
 Graham Barr E<lt>gb...@po...E<gt>
 
-Please report any bugs, or post any suggestions, to the perl-ldap mailing list
-E<lt>per...@pe...E<gt>.
+Please report any bugs, or post any suggestions, to the perl-ldap
+mailing list E<lt>per...@pe...E<gt>.
 
 =head1 COPYRIGHT
 
-Copyright (c) 1997-2000 Graham Barr. All rights reserved. This program is
-free software; you can redistribute it and/or modify it under the same
-terms as Perl itself.
+Copyright (c) 1997-2000 Graham Barr. All rights reserved. This program
+is free software; you can redistribute it and/or modify it under the
+same terms as Perl itself.
 
 =for html <hr>