diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3')
-rw-r--r-- | Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 | 104 |
1 files changed, 60 insertions, 44 deletions
diff --git a/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 index d36edd4a56c..780588f4c15 100644 --- a/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 +++ b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/MarriageNode.3 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -48,22 +40,25 @@ . ds R" '' '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 -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,67 +124,82 @@ .\" ======================================================================== .\" .IX Title "Pedigree::MarriageNode 3" -.TH Pedigree::MarriageNode 3 "2007-07-15" "perl v5.8.8" "User Contributed Perl Documentation" +.TH Pedigree::MarriageNode 3 "2007-07-15" "perl v5.10.0" "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 +.nh .SH "NAME" Pedigree::MarriageNode \- a marriage in a pedigree .SH "SYNOPSIS" .IX Header "SYNOPSIS" use Pedigree::MarriageNode; .PP -$node = new Pedigree::MarriageNode(\fI%params\fR); +\&\f(CW$node\fR = new Pedigree::MarriageNode(\fI\f(CI%params\fI\fR); .PP -$FSpouse = \f(CW$node\fR\->\fIFSpouse()\fR; +\&\f(CW$FSpouse\fR = \f(CW$node\fR\->\fIFSpouse()\fR; .PP -$MSpouse = \f(CW$node\fR\->\fIMSpouse()\fR; +\&\f(CW$MSpouse\fR = \f(CW$node\fR\->\fIMSpouse()\fR; .PP -$consang = \f(CW$self\fR\->\fIisConsanguinic()\fR; +\&\f(CW$consang\fR = \f(CW$self\fR\->\fIisConsanguinic()\fR; .PP -$area = \f(CW$node\fR\->\fISetArea()\fR; +\&\f(CW$area\fR = \f(CW$node\fR\->\fISetArea()\fR; .PP -$node\->CalcAbsCoord(\fI$x\fR, \fI$y\fR); +\&\f(CW$node\fR\->CalcAbsCoord(\fI\f(CI$x\fI\fR, \fI\f(CI$y\fI\fR); .PP -$node\->DrawNode(\fI$xidst\fR, \fI$ydist\fR, \fI$belowtextfont\fR, \fI$abovetextfont\fR, -\&\fI@fieldsfornode\fR); +\&\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 -$node\->\fIDrawConnections()\fR; +\&\f(CW$node\fR\->\fIDrawConnections()\fR; .SH "DESCRIPTION" .IX Header "DESCRIPTION" This package contains data about a marriage. -.IP "\fBnew\fR(\fI%params\fR);" 4 -.IX Item "new(%params);" +.Sp +.RS 4 +\&\fBnew\fR(\fI\f(CI%params\fI\fR); +.Sp Construct a new node from the given parameters. -.IP "\fBFSpouse\fR();" 4 -.IX Item "FSpouse();" +.Sp +\&\fBFSpouse\fR(); +.Sp Get female spouse of a node. -.IP "\fBMSpouse\fR();" 4 -.IX Item "MSpouse();" +.Sp +\&\fBMSpouse\fR(); +.Sp Get female spouse of a node. -.IP "\fBisConsanguinic\fR();" 4 -.IX Item "isConsanguinic();" +.Sp +\&\fBisConsanguinic\fR(); +.Sp Check whether the node is consanguinic -.IP "\fBSetArea\fR();" 4 -.IX Item "SetArea();" +.Sp +\&\fBSetArea\fR(); +.Sp 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 function to all descendants. The subroutine returns the reference to the created area. -.IP "\fBCalcAbsCoor\fR(\fI$x\fR, $<y>);" 4 -.IX Item "CalcAbsCoor($x, $<y>);" +.Sp +\&\fBCalcAbsCoor\fR(\fI\f(CI$x\fI\fR, $<y>); +.Sp Set the absolute coordinates of the given node, if the absolute -coordinates of the parent node are (\fI$x\fR, \fI$y\fR), and recursively +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. -.IP "\fBDrawNode\fR(\fI$xdist\fR, \fI$ydist\fR, \fI$belowtextfont\fR, \fI$abovetextfont\fR, \fI@fieldsfornode\fR);" 4 -.IX Item "DrawNode($xdist, $ydist, $belowtextfont, $abovetextfont, @fieldsfornode);" +.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 Output the command to draw this node. The parameters are distances between the nodes (in cm). -.IP "\fBDrawConnections\fR();" 4 -.IX Item "DrawConnections();" +.Sp +\&\fBDrawConnections\fR(); +.Sp 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$main::DEBUG\fR and set it to 0 +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" @@ -197,3 +207,9 @@ or 1. .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 |