summaryrefslogtreecommitdiff
path: root/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/MarriageNode.3
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/MarriageNode.3')
-rw-r--r--graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/MarriageNode.394
1 files changed, 43 insertions, 51 deletions
diff --git a/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/MarriageNode.3 b/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/MarriageNode.3
index 780588f4c1..98ed3ea79f 100644
--- a/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/MarriageNode.3
+++ b/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/MarriageNode.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::MarriageNode 3"
-.TH Pedigree::MarriageNode 3 "2007-07-15" "perl v5.10.0" "User Contributed Perl Documentation"
+.TH Pedigree::MarriageNode 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,79 +146,62 @@ use Pedigree::MarriageNode;
.PP
\&\f(CW$node\fR = new Pedigree::MarriageNode(\fI\f(CI%params\fI\fR);
.PP
-\&\f(CW$FSpouse\fR = \f(CW$node\fR\->\fIFSpouse()\fR;
+\&\f(CW$FSpouse\fR = \f(CW$node\fR\->\fBFSpouse()\fR;
.PP
-\&\f(CW$MSpouse\fR = \f(CW$node\fR\->\fIMSpouse()\fR;
+\&\f(CW$MSpouse\fR = \f(CW$node\fR\->\fBMSpouse()\fR;
.PP
-\&\f(CW$consang\fR = \f(CW$self\fR\->\fIisConsanguinic()\fR;
+\&\f(CW$consang\fR = \f(CW$self\fR\->\fBisConsanguinic()\fR;
.PP
-\&\f(CW$area\fR = \f(CW$node\fR\->\fISetArea()\fR;
+\&\f(CW$area\fR = \f(CW$node\fR\->\fBSetArea()\fR;
.PP
\&\f(CW$node\fR\->CalcAbsCoord(\fI\f(CI$x\fI\fR, \fI\f(CI$y\fI\fR);
.PP
\&\f(CW$node\fR\->DrawNode(\fI\f(CI$xidst\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, \fI\f(CI$abovetextfont\fI\fR,
\&\fI\f(CI@fieldsfornode\fI\fR);
.PP
-\&\f(CW$node\fR\->\fIDrawConnections()\fR;
+\&\f(CW$node\fR\->\fBDrawConnections()\fR;
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package contains data about a marriage.
-.Sp
-.RS 4
-\&\fBnew\fR(\fI\f(CI%params\fI\fR);
-.Sp
+.IP "\fBnew\fR(\fI\f(CI%params\fI\fR);" 4
+.IX Item "new(%params);"
Construct a new node from the given parameters.
-.Sp
-\&\fBFSpouse\fR();
-.Sp
+.IP "\fBFSpouse\fR();" 4
+.IX Item "FSpouse();"
Get female spouse of a node.
-.Sp
-\&\fBMSpouse\fR();
-.Sp
+.IP "\fBMSpouse\fR();" 4
+.IX Item "MSpouse();"
Get female spouse of a node.
-.Sp
-\&\fBisConsanguinic\fR();
-.Sp
+.IP "\fBisConsanguinic\fR();" 4
+.IX Item "isConsanguinic();"
Check whether the node is consanguinic
-.Sp
-\&\fBSetArea\fR();
-.Sp
+.IP "\fBSetArea\fR();" 4
+.IX Item "SetArea();"
Calculate relative coordinates for all nodes, that are descendants of
the given node \fIand\fR the spouses that form the marriage. We create a
-\&\fIPedigree::Area\fR\|(3) around the given node and recursively apply the
+\&\fBPedigree::Area\fR\|(3) around the given node and recursively apply the
function to all descendants. The subroutine
returns the reference to the created area.
-.Sp
-\&\fBCalcAbsCoor\fR(\fI\f(CI$x\fI\fR, $<y>);
-.Sp
+.IP "\fBCalcAbsCoor\fR(\fI\f(CI$x\fI\fR, $<y>);" 4
+.IX Item "CalcAbsCoor($x, $<y>);"
Set the absolute coordinates of the given node, if the absolute
coordinates of the parent node are (\fI\f(CI$x\fI\fR, \fI\f(CI$y\fI\fR), and recursively
do this for all descendants of this node, and right and left clumps.
-.Sp
-\&\fBDrawNode\fR(\fI\f(CI$xdist\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, \fI\f(CI$abovetextfont\fI\fR,
-\&\fI\f(CI@fieldsfornode\fI\fR);
-.Sp
+.IP "\fBDrawNode\fR(\fI\f(CI$xdist\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, \fI\f(CI$abovetextfont\fI\fR, \fI\f(CI@fieldsfornode\fI\fR);" 4
+.IX Item "DrawNode($xdist, $ydist, $belowtextfont, $abovetextfont, @fieldsfornode);"
Output the command to draw this node. The parameters are
distances between the nodes (in cm).
-.Sp
-\&\fBDrawConnections\fR();
-.Sp
+.IP "\fBDrawConnections\fR();" 4
+.IX Item "DrawConnections();"
Draw the connections from the given node to its descendants and
the spouses
-.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 33:" 4
-.IX Item "Around line 33:"
-You can't have =items (as at line 55) unless the first thing after the =over is an =item