summaryrefslogtreecommitdiff
path: root/doxygen/man/man3/cmd2_OptionParser.3
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/man/man3/cmd2_OptionParser.3')
-rw-r--r--doxygen/man/man3/cmd2_OptionParser.382
1 files changed, 82 insertions, 0 deletions
diff --git a/doxygen/man/man3/cmd2_OptionParser.3 b/doxygen/man/man3/cmd2_OptionParser.3
new file mode 100644
index 0000000..15d1f0a
--- /dev/null
+++ b/doxygen/man/man3/cmd2_OptionParser.3
@@ -0,0 +1,82 @@
+.TH "cmd2::OptionParser" 3 "Fri Sep 9 2011" "Cmd2" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+cmd2::OptionParser \-
+.SH SYNOPSIS
+.br
+.PP
+.SS "Public Member Functions"
+
+.in +1c
+.ti -1c
+.RI "def \fBerror\fP"
+.br
+.ti -1c
+.RI "def \fBexit\fP"
+.br
+.ti -1c
+.RI "def \fBprint_help\fP"
+.br
+.in -1c
+.SH "Detailed Description"
+.PP
+Definition at line 64 of file cmd2\&.py'\&.
+.SH "Member Function Documentation"
+.PP
+.SS "def cmd2::OptionParser::error (self, msg)".PP
+.nf
+error(msg : string)
+
+Print a usage message incorporating 'msg' to stderr and exit.
+If you override this in a subclass, it should not return -- it
+should either exit or raise an exception.
+.fi
+.PP
+
+.PP
+Definition at line 77 of file cmd2\&.py'\&.
+.PP
+.nf
+77
+78 def error(self, msg):
+79 '''error(msg : string)
+80
+81 Print a usage message incorporating 'msg' to stderr and exit\&.
+82 If you override this in a subclass, it should not return -- it
+83 should either exit or raise an exception\&.
+84 '''
+85 raise optparse\&.OptParseError(msg)
+
+.fi
+.SS "def cmd2::OptionParser::exit (self, status = \fC0\fP, msg = \fCNone\fP)"
+.PP
+Definition at line 65 of file cmd2\&.py'\&.
+.PP
+.nf
+65
+66 def exit(self, status=0, msg=None):
+67 self\&.values\&._exit = True
+68 if msg:
+69 print (msg)
+
+.fi
+.SS "def cmd2::OptionParser::print_help (self, args, kwargs)"
+.PP
+Definition at line 70 of file cmd2\&.py'\&.
+.PP
+.nf
+70
+71 def print_help(self, *args, **kwargs):
+72 try:
+73 print (self\&._func\&.__doc__)
+74 except AttributeError:
+75 pass
+76 optparse\&.OptionParser\&.print_help(self, *args, **kwargs)
+
+.fi
+
+
+.SH "Author"
+.PP
+Generated automatically by Doxygen for Cmd2 from the source code'\&.