diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/pedigree-perl/Pedigree/PersonNode.3')
-rw-r--r-- | Master/texmf-dist/doc/support/pedigree-perl/Pedigree/PersonNode.3 | 118 |
1 files changed, 53 insertions, 65 deletions
diff --git a/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/PersonNode.3 b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/PersonNode.3 index 8876211f536..f3a94013009 100644 --- a/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/PersonNode.3 +++ b/Master/texmf-dist/doc/support/pedigree-perl/Pedigree/PersonNode.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::PersonNode 3" -.TH Pedigree::PersonNode 3 "2007-07-22" "perl v5.10.0" "User Contributed Perl Documentation" +.TH Pedigree::PersonNode 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,20 +146,20 @@ use Pedigree::PersonNode; .PP \&\f(CW$node\fR = new Pedigree::PersonNode(\fI\f(CI%params\fI\fR); .PP -\&\f(CW$Id\fR = \f(CW$node\fR\->\fIMotherId()\fR; -\&\f(CW$Id\fR = \f(CW$node\fR\->\fIFatherId()\fR; +\&\f(CW$Id\fR = \f(CW$node\fR\->\fBMotherId()\fR; +\&\f(CW$Id\fR = \f(CW$node\fR\->\fBFatherId()\fR; .PP -\&\f(CW$isProband\fR = \f(CW$node\fR\->\fIisProband()\fR; +\&\f(CW$isProband\fR = \f(CW$node\fR\->\fBisProband()\fR; .PP -\&\f(CW$sex\fR = \f(CW$node\fR\->\fISex()\fR; +\&\f(CW$sex\fR = \f(CW$node\fR\->\fBSex()\fR; .PP -\&\f(CW$DoB\fR = \f(CW$node\fR\->\fIDoB()\fR; +\&\f(CW$DoB\fR = \f(CW$node\fR\->\fBDoB()\fR; .PP -\&\f(CW$DoD\fR = \f(CW$node\fR\->\fIDoD()\fR; +\&\f(CW$DoD\fR = \f(CW$node\fR\->\fBDoD()\fR; .PP -\&\f(CW$cond\fR = \f(CW$node\fR\->\fICondition()\fR; +\&\f(CW$cond\fR = \f(CW$node\fR\->\fBCondition()\fR; .PP -\&\f(CW$GenName\fR = \f(CW$node\fR\->\fIGetGenName()\fR; +\&\f(CW$GenName\fR = \f(CW$node\fR\->\fBGetGenName()\fR; .PP \&\f(CW$node\fR\->SetGenName(\fI\f(CI$name\fI\fR); .PP @@ -161,72 +170,51 @@ use Pedigree::PersonNode; .SH "DESCRIPTION" .IX Header "DESCRIPTION" This package contains data about a person. -.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 -\&\fBMotherId\fR(); -.Sp +.IP "\fBMotherId\fR();" 4 +.IX Item "MotherId();" Return Mother Id. -.Sp -\&\fBFatherId\fR(); -.Sp +.IP "\fBFatherId\fR();" 4 +.IX Item "FatherId();" Return Father Id. -.Sp -\&\fBisProband\fR(); -.Sp +.IP "\fBisProband\fR();" 4 +.IX Item "isProband();" Return 1 if the pesron is a Proband and zero otherwise -.Sp -\&\fBSex\fR(); -.Sp +.IP "\fBSex\fR();" 4 +.IX Item "Sex();" Get the sex of the node -.Sp -\&\fBDoB\fR(); -.Sp +.IP "\fBDoB\fR();" 4 +.IX Item "DoB();" Get the DoB of the node -.Sp -\&\fBDoD\fR(); -.Sp +.IP "\fBDoD\fR();" 4 +.IX Item "DoD();" Get the DoB of the node -.Sp -\&\fBCondition\fR(); -.Sp +.IP "\fBCondition\fR();" 4 +.IX Item "Condition();" Returns node conditon. -.Sp -\&\fBGetGenName\fR(); -.Sp +.IP "\fBGetGenName\fR();" 4 +.IX Item "GetGenName();" Find the generation name for the node -.Sp -\&\fBSetGenName\fR(\fI\f(CI$name\fI\fR); -.Sp +.IP "\fBSetGenName\fR(\fI\f(CI$name\fI\fR);" 4 +.IX Item "SetGenName($name);" Set the generation name of the node -.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) and fields for abovetext. -.Sp -\&\fBPrintLegend\fR(\fI\f(CI$lang\fI\fR, \fI\f(CI@fields\fI\fR); -.Sp +.IP "\fBPrintLegend\fR(\fI\f(CI$lang\fI\fR, \fI\f(CI@fields\fI\fR);" 4 +.IX Item "PrintLegend($lang, @fields);" Print the legend for the given node, including \fI\f(CI@fields\fI\fR in the given language \fI\f(CI$lang\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 39:" 4 -.IX Item "Around line 39:" -You can't have =items (as at line 58) unless the first thing after the =over is an =item |