diff options
Diffstat (limited to 'doxygen/man/man3/pirate3_Pirate.3')
-rw-r--r-- | doxygen/man/man3/pirate3_Pirate.3 | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/doxygen/man/man3/pirate3_Pirate.3 b/doxygen/man/man3/pirate3_Pirate.3 new file mode 100644 index 0000000..93c4745 --- /dev/null +++ b/doxygen/man/man3/pirate3_Pirate.3 @@ -0,0 +1,115 @@ +.TH "pirate3::Pirate" 3 "Fri Sep 9 2011" "Cmd2" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pirate3::Pirate \- +.SH SYNOPSIS +.br +.PP +.PP +Inherits Cmd'\&. +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fBdo_drink\fP" +.br +.ti -1c +.RI "def \fBdo_loot\fP" +.br +.ti -1c +.RI "def \fBpostcmd\fP" +.br +.ti -1c +.RI "def \fBprecmd\fP" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBinitial_gold\fP" +.br +.in -1c +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "int \fBgold\fP = 3" +.br +.in -1c +.SH "Detailed Description" +.PP +Definition at line 4 of file pirate3\&.py'\&. +.SH "Member Function Documentation" +.PP +.SS "def pirate3::Pirate::do_drink (self, arg)" +.PP +Definition at line 9 of file pirate3\&.py'\&. +.PP +References pirate2::Pirate::gold, and gold\&. +.PP +.nf +9 +10 def do_drink(self, arg): +11 'Drown your sorrrows in rrrum\&.' + self\&.gold -= 1 +.fi +.SS "def pirate3::Pirate::do_loot (self, arg)" +.PP +Definition at line 6 of file pirate3\&.py'\&. +.PP +References pirate2::Pirate::gold, and gold\&. +.PP +.nf +6 +7 def do_loot(self, arg): +8 'Seize booty from a passing ship\&.' + self\&.gold += 1 +.fi +.SS "def pirate3::Pirate::postcmd (self, stop, line)" +.PP +Definition at line 15 of file pirate3\&.py'\&. +.PP +References pirate2::Pirate::gold, gold, and initial_gold\&. +.PP +Referenced by cmd2::Cmd::onecmd_plus_hooks()\&. +.PP +.nf +15 +16 def postcmd(self, stop, line): +17 if self\&.gold != self\&.initial_gold: +18 print('Now we gots {0} doubloons' +19 \&.format(self\&.gold)) + +.fi +.SS "def pirate3::Pirate::precmd (self, line)" +.PP +Definition at line 12 of file pirate3\&.py'\&. +.PP +References pirate2::Pirate::gold, gold, and initial_gold\&. +.PP +Referenced by cmd2::Cmd::onecmd_plus_hooks()\&. +.PP +.nf +12 +13 def precmd(self, line): +14 self\&.initial_gold = self\&.gold + return line +.fi +.SH "Member Data Documentation" +.PP +.SS "int \fBpirate3::Pirate::gold\fP = 3\fC [static]\fP" +.PP +Definition at line 5 of file pirate3\&.py'\&. +.PP +Referenced by do_drink(), pirate5::Pirate::do_drink(), pirate4::Pirate::do_drink(), pirate7::Pirate::do_drink(), pirate8::Pirate::do_drink(), pirate6::Pirate::do_drink(), pirate5::Pirate::do_loot(), pirate4::Pirate::do_loot(), do_loot(), pirate7::Pirate::do_loot(), pirate8::Pirate::do_loot(), pirate6::Pirate::do_loot(), postcmd(), pirate4::Pirate::postcmd(), pirate5::Pirate::postcmd(), pirate7::Pirate::postcmd(), pirate8::Pirate::postcmd(), pirate6::Pirate::postcmd(), precmd(), pirate5::Pirate::precmd(), pirate4::Pirate::precmd(), pirate8::Pirate::precmd(), pirate7::Pirate::precmd(), and pirate6::Pirate::precmd()\&. +.SS "\fBpirate3::Pirate::initial_gold\fP" +.PP +Definition at line 12 of file pirate3\&.py'\&. +.PP +Referenced by postcmd(), pirate4::Pirate::postcmd(), pirate5::Pirate::postcmd(), pirate7::Pirate::postcmd(), pirate8::Pirate::postcmd(), pirate6::Pirate::postcmd(), precmd(), pirate5::Pirate::precmd(), pirate4::Pirate::precmd(), pirate8::Pirate::precmd(), pirate7::Pirate::precmd(), and pirate6::Pirate::precmd()\&. + +.SH "Author" +.PP +Generated automatically by Doxygen for Cmd2 from the source code'\&. |