summaryrefslogtreecommitdiff
path: root/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-10-03 03:01:24 +0000
committerNorbert Preining <norbert@preining.info>2021-10-03 03:01:24 +0000
commitc7bf3f5a728fcb426d1aa38fbec211d4344a3725 (patch)
tree87fbde2d0e79f9e5fce12cbb71971717568fbf9d /graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3
parentac5a96ddb02c62d71eb214ed35e3be9a154d991f (diff)
CTAN sync 202110030301
Diffstat (limited to 'graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3')
-rw-r--r--graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3114
1 files changed, 51 insertions, 63 deletions
diff --git a/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3 b/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3
index c200cbbf0f..42b8d88c72 100644
--- a/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3
+++ b/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Area.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -38,27 +38,36 @@
. ds PI \(*p
. ds L" ``
. ds R" ''
+. 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 turned on, we'll generate index entries on stderr for
+.\" 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.
-.ie \nF \{\
-. de IX
-. tm Index:\\$1\t\\n%\t"\\$2"
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
..
-. nr % 0
-. rr F
-.\}
-.el \{\
-. 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
@@ -124,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "Pedigree::Area 3"
-.TH Pedigree::Area 3 "2007-07-08" "perl v5.10.0" "User Contributed Perl Documentation"
+.TH Pedigree::Area 3 "2021-10-02" "perl v5.18.4" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -137,11 +146,11 @@ use Pedigree::Area;
.PP
\&\f(CW$area\fR = new Pedigree::Area($node);
.PP
-\&\f(CW$Ymin\fR=$area\->\fIGetYmin()\fR;
+\&\f(CW$Ymin\fR=$area\->\fBGetYmin()\fR;
.PP
\&\f(CW$area\fR\->SetYmin($Ymin);
.PP
-\&\f(CW$Ymax\fR=$area\->\fIGetYmax()\fR;
+\&\f(CW$Ymax\fR=$area\->\fBGetYmax()\fR;
.PP
\&\f(CW$area\fR\->SetYmax($Ymax);
.PP
@@ -157,12 +166,12 @@ use Pedigree::Area;
.PP
\&\f(CW$area\fR\->AddLeft($otherarea);
.PP
-\&\f(CW$rootnode\fR=$area\->\fIGetRootNode()\fR;
+\&\f(CW$rootnode\fR=$area\->\fBGetRootNode()\fR;
.PP
\&\f(CW$area\fR\->MoveLowerLayers($x);
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-The algorithm of \fIpedigree\fR\|(1) uses the notion of area: a part of
+The algorithm of \fBpedigree\fR\|(1) uses the notion of area: a part of
a picture taken by a tree or a clump. This package implements this
notion.
.PP
@@ -173,79 +182,58 @@ All distances are calculated as relative to the coordinates of the
The units are distances between the nodes in X and Y direction. The
Y axis is \fIdownward\fR: the earlier generations have smaller Y
coordinates.
-.Sp
-.RS 4
-\&\fBnew\fR(\fI\f(CI$rootnode\fI\fR);
-.Sp
+.IP "\fBnew\fR(\fI\f(CI$rootnode\fI\fR);" 4
+.IX Item "new($rootnode);"
Construct a new area around the given rootnode
-.Sp
-\&\fBGetYmin\fR();
-.Sp
+.IP "\fBGetYmin\fR();" 4
+.IX Item "GetYmin();"
Get the lower bound of the area.
-.Sp
-\&\fBSetYmin\fR(\fI\f(CI$y\fI\fR);
-.Sp
+.IP "\fBSetYmin\fR(\fI\f(CI$y\fI\fR);" 4
+.IX Item "SetYmin($y);"
Set the lower bound of the area.
-.Sp
-\&\fBGetYmax\fR();
-.Sp
+.IP "\fBGetYmax\fR();" 4
+.IX Item "GetYmax();"
Get the upper bound of the area.
-.Sp
-\&\fBSetYmax\fR(\fI\f(CI$y\fI\fR);
-.Sp
+.IP "\fBSetYmax\fR(\fI\f(CI$y\fI\fR);" 4
+.IX Item "SetYmax($y);"
Set the upper bound of the area.
-.Sp
-\&\fBGetXmin\fR(\fI\f(CI$y\fI\fR);
-.Sp
+.IP "\fBGetXmin\fR(\fI\f(CI$y\fI\fR);" 4
+.IX Item "GetXmin($y);"
Get the minimal X coordinate of the area on the level Y.
-.Sp
-\&\fBSetXmin\fR(\fI\f(CI$y\fI, \f(CI$x\fI\fR);
-.Sp
+.IP "\fBSetXmin\fR(\fI\f(CI$y\fI, \f(CI$x\fI\fR);" 4
+.IX Item "SetXmin($y, $x);"
Set the minimal X coordinate of the area on the level Y.
-.Sp
-\&\fBGetXmax\fR(\fI\f(CI$y\fI\fR);
-.Sp
+.IP "\fBGetXmax\fR(\fI\f(CI$y\fI\fR);" 4
+.IX Item "GetXmax($y);"
Get the maximal X coordinate of the area the the level Y.
-.Sp
-\&\fBSetXmax\fR(\fI\f(CI$y\fI, \f(CI$x\fI\fR);
-.Sp
+.IP "\fBSetXmax\fR(\fI\f(CI$y\fI, \f(CI$x\fI\fR);" 4
+.IX Item "SetXmax($y, $x);"
Set the maximal X coordinate of the area the the level Y.
-.Sp
-\&\fBAddRight\fR(\fI\f(CI$otherarea\fI\fR);
-.Sp
+.IP "\fBAddRight\fR(\fI\f(CI$otherarea\fI\fR);" 4
+.IX Item "AddRight($otherarea);"
Add the new area \fI\f(CI$otherarea\fI\fR to the given area at the right. The
\&\*(L"other area\*(R" should have a root node that is relative to our root
node. The relative Y of the other root node is used, the relative
X is set.
-.Sp
-\&\fBAddLeft\fR(\fI\f(CI$otherarea\fI\fR);
-.Sp
+.IP "\fBAddLeft\fR(\fI\f(CI$otherarea\fI\fR);" 4
+.IX Item "AddLeft($otherarea);"
Add the new area \fI\f(CI$otherarea\fI\fR to the given area at the left. The
\&\*(L"other area\*(R" should have a root node that is relative to our root
node. The relative Y of the other root node is used, the relative
X is set.
-.Sp
-\&\fBGetRootNode\fR();
-.Sp
+.IP "\fBGetRootNode\fR();" 4
+.IX Item "GetRootNode();"
Return the root node of the area.
-.Sp
-\&\fBMoveLowerLayers\fR(\fI\f(CI$x\fI\fR);
-.Sp
+.IP "\fBMoveLowerLayers\fR(\fI\f(CI$x\fI\fR);" 4
+.IX Item "MoveLowerLayers($x);"
Shift the lower layers (>0) of the area in the X direction by \fI\f(CI$x\fI\fR
-.RE
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
The calling program should define \fB\f(CB$main::DEBUG\fB\fR and set it to 0
or 1.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-\&\fIpedigree\fR\|(1), \fIPedigree\fR\|(3)
+\&\fBpedigree\fR\|(1), \fBPedigree\fR\|(3)
.SH "AUTHOR"
.IX Header "AUTHOR"
Boris Veytsman, Leila Akhmadeeva, 2006, 2007
-.SH "POD ERRORS"
-.IX Header "POD ERRORS"
-Hey! \fBThe above document had some coding errors, which are explained below:\fR
-.IP "Around line 51:" 4
-.IX Item "Around line 51:"
-You can't have =items (as at line 69) unless the first thing after the =over is an =item