diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/TAP::Object.3perl | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/TAP::Object.3perl')
-rw-r--r-- | upstream/debian-unstable/man3/TAP::Object.3perl | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/TAP::Object.3perl b/upstream/debian-unstable/man3/TAP::Object.3perl new file mode 100644 index 00000000..06f84377 --- /dev/null +++ b/upstream/debian-unstable/man3/TAP::Object.3perl @@ -0,0 +1,153 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "TAP::Object 3perl" +.TH TAP::Object 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +TAP::Object \- Base class that provides common functionality to all "TAP::*" modules +.SH VERSION +.IX Header "VERSION" +Version 3.44 +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& package TAP::Whatever; +\& +\& use strict; +\& +\& use base \*(AqTAP::Object\*(Aq; +\& +\& # new() implementation by TAP::Object +\& sub _initialize { +\& my ( $self, @args) = @_; +\& # initialize your object +\& return $self; +\& } +\& +\& # ... later ... +\& my $obj = TAP::Whatever\->new(@args); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\f(CW\*(C`TAP::Object\*(C'\fR provides a default constructor and exception model for all +\&\f(CW\*(C`TAP::*\*(C'\fR classes. Exceptions are raised using Carp. +.SH METHODS +.IX Header "METHODS" +.SS "Class Methods" +.IX Subsection "Class Methods" +\fR\f(CI\*(C`new\*(C'\fR\fI\fR +.IX Subsection "new" +.PP +Create a new object. Any arguments passed to \f(CW\*(C`new\*(C'\fR will be passed on to the +"_initialize" method. Returns a new object. +.SS "Instance Methods" +.IX Subsection "Instance Methods" +\fR\f(CI\*(C`_initialize\*(C'\fR\fI\fR +.IX Subsection "_initialize" +.PP +Initializes a new object. This method is a stub by default, you should override +it as appropriate. +.PP +\&\fINote:\fR "new" expects you to return \f(CW$self\fR or raise an exception. See +"_croak", and Carp. +.PP +\fR\f(CI\*(C`_croak\*(C'\fR\fI\fR +.IX Subsection "_croak" +.PP +Raise an exception using \f(CW\*(C`croak\*(C'\fR from Carp, eg: +.PP +.Vb 1 +\& $self\->_croak( \*(Aqwhy me?\*(Aq, \*(Aqaaarrgh!\*(Aq ); +.Ve +.PP +May also be called as a \fIclass\fR method. +.PP +.Vb 1 +\& $class\->_croak( \*(Aqthis works too\*(Aq ); +.Ve +.PP +\fR\f(CI\*(C`_confess\*(C'\fR\fI\fR +.IX Subsection "_confess" +.PP +Raise an exception using \f(CW\*(C`confess\*(C'\fR from Carp, eg: +.PP +.Vb 1 +\& $self\->_confess( \*(Aqwhy me?\*(Aq, \*(Aqaaarrgh!\*(Aq ); +.Ve +.PP +May also be called as a \fIclass\fR method. +.PP +.Vb 1 +\& $class\->_confess( \*(Aqthis works too\*(Aq ); +.Ve +.PP +\fR\f(CI\*(C`_construct\*(C'\fR\fI\fR +.IX Subsection "_construct" +.PP +Create a new instance of the specified class. +.PP +\fR\f(CI\*(C`mk_methods\*(C'\fR\fI\fR +.IX Subsection "mk_methods" +.PP +Create simple getter/setters. +.PP +.Vb 1 +\& _\|_PACKAGE_\|_\->mk_methods(@method_names); +.Ve |