Mailing List Archive

Re: cvs commit: modperl-docs/src/docs/2.0/api/Apache Module.pod
gozer@apache.org wrote:
> gozer 2004/08/10 11:13:24
[...]

Thanks for working on these, Philippe. There are a few nuances though :)

> =head2 C<cmds>
>
> -META: Autogenerated - needs to be reviewed/completed
> -
> -A command_rec table that describes all of the directives this module
> +An Apache::Command table that describes all of the directives this module
> defines.
>
> $cmd_rec = $module->cmds();

this doc entry is incomplete. this method is get/set but the doc
documents only the get functionality. Please compare against .xs file
and make sure that all possible invocations are documented and (mostly)
tested, before a module can be considered complete.

I haven't looked through other methods of this module and the other
modules yet. So if you can take a look and finish them off that would be
great. Let me know when this is done, and I'll review these then.

Thanks.


--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: cvs commit: modperl-docs/src/docs/2.0/api/Apache Module.pod [ In reply to ]
gozer@apache.org wrote:
> gozer 2004/08/18 11:06:15
>
> Modified: src/docs/2.0/api/Apache Module.pod
> Log:
> Geoff pointed out that there was at least one documented use of
> $module->remove, so Apache::Module->remove_loaded_module should
> not have been removed. Re-adding it with documentation.
[...]
> +=head2 C<remove_loaded_module>
> +
> +Remove a module from the list of loaded modules permanently.
> +
> + $module->remove_loaded_module();
> +
> +=over 4
> +
> +=item obj: C<$module>
> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> )
> +
> +=item since: 1.99_12

missing:

=item ret: no return value


--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: cvs commit: modperl-docs/src/docs/2.0/api/Apache Module.pod [ In reply to ]
Stas Bekman wrote:
> gozer@apache.org wrote:
>
>>gozer 2004/08/18 11:06:15
>>
>> Modified: src/docs/2.0/api/Apache Module.pod
>> Log:
>> Geoff pointed out that there was at least one documented use of
>> $module->remove, so Apache::Module->remove_loaded_module should
>> not have been removed. Re-adding it with documentation.
>
> [...]
>
>> +=head2 C<remove_loaded_module>
>> +
>> +Remove a module from the list of loaded modules permanently.
>> +
>> + $module->remove_loaded_module();
>> +
>> +=over 4
>> +
>> +=item obj: C<$module>
>> +( C<L<Apache::Module object|docs::2.0::api::Apache::Module>> )
>> +
>> +=item since: 1.99_12
>
>
> missing:
>
> =item ret: no return value
>

Thanks! Fixed.

--
--------------------------------------------------------------------------------
Philippe M. Chiasson m/gozer\@(apache|cpan|ectoplasm)\.org/ GPG KeyID : 88C3A5A5
http://gozer.ectoplasm.org/ F9BF E0C2 480E 7680 1AE5 3631 CB32 A107 88C3A5A5