Adding documentation

This commit is contained in:
Kevin K 2015-02-27 22:19:48 -05:00
parent 335e9ff59b
commit 3f693870bb
2 changed files with 14 additions and 0 deletions

View file

@ -1,3 +1,11 @@
/// PosArg represents a positional argument, i.e. one that isn't preceded
/// by a `-` or `--`.
/// Example:
/// ```sh
/// $ myprog some_file
/// ```
/// where `some_file` is the first positional argument to `myprog`
/// **NOTE:** The index starts at `1` **NOT** `0`
pub struct PosArg {
pub name: &'static str,
pub help: Option<&'static str>,

View file

@ -1,5 +1,11 @@
#![crate_id = "clap"]
#![crate_type= "lib"]
#![feature(collections, core, libc, env)]
//! A simply library for parsing command line arguments when writing
//! command line applications.
pub use argmatches::ArgMatches;
pub use arg::Arg;
pub use app::App;