On 24 Jun 2001 [EMAIL PROTECTED] wrote:
> sbekman 01/06/24 01:15:21
>
> Modified: Apache-Test/lib/Apache TestServer.pm
> Log:
> - comply with return API convention (undocumented)
> - start to document the API
I've thrown in a very basic API doc for stop(). Obviously I would do
'return -1' in first place if I had the API :)
So what do we decide about documentation style, so we can start
documenting things as we go? As I've replied to brian's email, I'm in
favor of inline docs if it doesn't make the code harder to read.
Also Doug you were talking about self-documenting code, I don't remember I
saw any details about this thingy in the docs. Can you elaborate on this?
> Revision Changes Path
> 1.8 +12 -1 modperl-2.0/Apache-Test/lib/Apache/TestServer.pm
>
> Index: TestServer.pm
> ===================================================================
> RCS file: /home/cvs/modperl-2.0/Apache-Test/lib/Apache/TestServer.pm,v
> retrieving revision 1.7
> retrieving revision 1.8
> diff -u -r1.7 -r1.8
> --- TestServer.pm 2001/06/24 08:08:09 1.7
> +++ TestServer.pm 2001/06/24 08:15:21 1.8
> @@ -137,6 +137,17 @@
> }
> }
>
> +=head2 stop()
> +
> +attempt to stop the server.
> +
> +returns:
> +
> + on success: $pid of the server
> + on failure: -1
> +
> +=cut
> +
> sub stop {
> my $self = shift;
> my $aborted = shift;
> @@ -148,7 +159,7 @@
> my $port = $self->{config}->{vars}->{port};
>
> warning("server $self->{name} is not running"),
> - return unless $self->ping;
> + return -1 unless $self->ping;
>
> while ($self->ping) {
> #my $state = $tried_kill ? "still" : "already";
>
>
>
>
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:[EMAIL PROTECTED] http://apachetoday.com http://eXtropia.com/
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
