Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

getopts missing docs #12942

Merged
merged 1 commit into from
Mar 17, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions src/libgetopts/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -98,27 +98,34 @@ use std::vec;

/// Name of an option. Either a string or a single char.
#[deriving(Clone, Eq)]
#[allow(missing_doc)]
pub enum Name {
/// A string representing the long name of an option.
/// For example: "help"
Long(~str),
/// A char representing the short name of an option.
/// For example: 'h'
Short(char),
}

/// Describes whether an option has an argument.
#[deriving(Clone, Eq)]
#[allow(missing_doc)]
pub enum HasArg {
/// The option requires an argument.
Yes,
/// The option is just a flag, therefore no argument.
No,
/// The option argument is optional and it could or not exist.
Maybe,
}

/// Describes how often an option may occur.
#[deriving(Clone, Eq)]
#[allow(missing_doc)]
pub enum Occur {
/// The option occurs once.
Req,
/// The option could or not occur.
Optional,
/// The option occurs once or multiple times.
Multi,
}

Expand Down Expand Up @@ -176,12 +183,16 @@ pub struct Matches {
/// expected format. Call the `to_err_msg` method to retrieve the
/// error as a string.
#[deriving(Clone, Eq, Show)]
#[allow(missing_doc)]
pub enum Fail_ {
/// The option requires an argument but none was passed.
ArgumentMissing(~str),
/// The passed option is not declared among the possible options.
UnrecognizedOption(~str),
/// A required option is not present.
OptionMissing(~str),
/// A single occurence option is being used multiple times.
OptionDuplicated(~str),
/// There's an argument being passed to a non-argument option.
UnexpectedArgument(~str),
}

Expand Down