Skip to content

Commit

Permalink
Item14237: Mindor docs adjustments.
Browse files Browse the repository at this point in the history
  • Loading branch information
vrurg committed Oct 21, 2017
1 parent 0fe8c1b commit b01c62f
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 12 deletions.
1 change: 1 addition & 0 deletions UnitTestContrib/lib/Unit/PlackTestCase.pm
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ has testClientList => (
);

=begin TML
---+++ ObjectAttribute defaultAppClass
Default name of the class to instantiate the application object.
Expand Down
68 changes: 63 additions & 5 deletions core/lib/Foswiki/OopsException.pm
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

=begin TML
---+ package Foswiki::OopsException
---+!! Class Foswiki::OopsException
Exception used to raise a request to output a preformatted page.
Expand Down Expand Up @@ -99,38 +99,96 @@ extends qw<Foswiki::Exception>;
# harmless. Otherwise it all depends on particular code interpretation...
with qw<Foswiki::Exception::Harmless>;

#our @_newParameters = qw( template );
=begin TML
---++ ATTRIBUTES
=cut

=begin TML
---+++ ObjectAttribute template
=cut

has template => (
is => 'rwp',
default => '',
required => 1,
);

=begin TML
---+++ ObjectAttribute web
=cut

has web => (
is => 'ro',
default => '',
);

=begin TML
---+++ ObjectAttribute topic
=cut

has topic => (
is => 'ro',
default => '',
);

=begin TML
---+++ ObjectAttribute def
=cut

has def => (
is => 'ro',
default => '',
);

=begin TML
---+++ ObjectAttribute keep
=cut

has keep => (
is => 'ro',
default => '',
);

=begin TML
---+++ ObjectAttribute params
=cut

has params => ( is => 'rwp', );

=begin TML
---+++ ObjectAttribute status
=cut

has status => (
is => 'rw',
default => 500,
);

=begin TML
---++ ClassMethod new( $template, ...)
---++ METHODS
=cut

=begin TML
---+++ ClassMethod new( $template, ...)
* =template= is the name of an oops template. e.g. 'bathplugin' refers to =templates/oopsbathplugin.tmpl=
The remaining parameters are interpreted as key-value pairs. The following keys are used:
* =web= will be used as the web for the oops
Expand Down Expand Up @@ -187,7 +245,7 @@ sub BUILD {

=begin TML
---++ ObjectMethod stringify( [$wihtTemplate] ) -> $string
---+++ ObjectMethod stringify( [$wihtTemplate] ) -> $string
Generates a string representation for the object. if $withTemplate is true, and
the exception specifies a def, then that def is expanded. This is to allow
Expand Down Expand Up @@ -257,7 +315,7 @@ sub redirect {

=begin TML
---++ ObjectMethod generate( $session )
---+++ ObjectMethod generate( $session )
Generate an error page for the exception. This will output the error page
to the browser. The default HTTP Status for an Oops page is 500. This
Expand Down
1 change: 0 additions & 1 deletion core/lib/Foswiki/Request/Attachment.pm
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ The following attributes are parsed from the path_info and/or query params (see
=cut

package Foswiki::Request::Attachment;
use v5.14;

use Assert;
use IO::File ();
Expand Down
1 change: 0 additions & 1 deletion core/lib/Foswiki/Request/Cache.pm
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# See bottom of file for license and copyright information
package Foswiki::Request::Cache;
use v5.14;

=begin TML
Expand Down
16 changes: 11 additions & 5 deletions core/lib/Foswiki/UI.pm
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ use constant TRACE_REQUEST => 0;

=begin TML
---++ StaticMethod logon($app)
---++ METHODS
=cut

=begin TML
---+++ StaticMethod logon($app)
Handler for "logon" action.
* =$app= is a Foswiki session object
Expand Down Expand Up @@ -73,7 +79,7 @@ sub logon {

=begin TML
---++ ObjectMethod checkWebExists( $web [, $op] )
---+++ ObjectMethod checkWebExists( $web [, $op] )
Check if the web exists. If it doesn't, will throw an oops exception.
Expand Down Expand Up @@ -127,7 +133,7 @@ sub checkWebExists {

=begin TML
---++ ObjectMethod topicExists( $web, $topic [, $op] ) => boolean
---+++ ObjectMethod topicExists( $web, $topic [, $op] ) => boolean
Check if the given topic exists, throwing an OopsException if it doesn't. $op is
the user operation being performed. $app->request->action is used if $op is
Expand Down Expand Up @@ -169,7 +175,7 @@ sub checkTopicExists {

=begin TML
---++ ObjectMethod checkAccess( $mode, $topicObject )
---+++ ObjectMethod checkAccess( $mode, $topicObject )
Check if the given mode of access by the given user to the given
web.topic is permissible, throwing a Foswiki::AccessControlException if not.
Expand All @@ -195,7 +201,7 @@ sub checkAccess {

=begin TML
---++ ObjectMethod checkValidationKey
---+++ ObjectMethod checkValidationKey
Check the validation key for the given action. Throws an exception
if the validation key isn't valid (handled in _execute(), above)
Expand Down

0 comments on commit b01c62f

Please sign in to comment.