Return-Path: Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: (qmail 13084 invoked from network); 7 Jul 2010 14:40:54 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 7 Jul 2010 14:40:54 -0000 Received: (qmail 32907 invoked by uid 500); 7 Jul 2010 14:40:54 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 32832 invoked by uid 500); 7 Jul 2010 14:40:53 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 32825 invoked by uid 99); 7 Jul 2010 14:40:53 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Jul 2010 14:40:53 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Jul 2010 14:40:50 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id B806123889E5; Wed, 7 Jul 2010 14:39:27 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r961393 - in /commons/proper/cli/trunk/src/site/xdoc: introduction.xml properties.xml usage.xml Date: Wed, 07 Jul 2010 14:39:27 -0000 To: commits@commons.apache.org From: ebourg@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20100707143927.B806123889E5@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: ebourg Date: Wed Jul 7 14:39:27 2010 New Revision: 961393 URL: http://svn.apache.org/viewvc?rev=961393&view=rev Log: Changed the links to the javadoc from the site documentation, the target directory is now independent from the version Modified: commons/proper/cli/trunk/src/site/xdoc/introduction.xml commons/proper/cli/trunk/src/site/xdoc/properties.xml commons/proper/cli/trunk/src/site/xdoc/usage.xml Modified: commons/proper/cli/trunk/src/site/xdoc/introduction.xml URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/site/xdoc/introduction.xml?rev=961393&r1=961392&r2=961393&view=diff ============================================================================== --- commons/proper/cli/trunk/src/site/xdoc/introduction.xml (original) +++ commons/proper/cli/trunk/src/site/xdoc/introduction.xml Wed Jul 7 14:39:27 2010 @@ -39,9 +39,9 @@ to define the interface to the application.

- CLI uses the + CLI uses the Options class, as a container for - + Option instances. There are two ways to create Options in CLI. One of them is via the constructors, the other way is via the factory methods defined in @@ -66,11 +66,11 @@

The parse method defined on - + CommandLineParser takes an Options instance and a String[] of arguments and returns a - + CommandLine.

Modified: commons/proper/cli/trunk/src/site/xdoc/properties.xml URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/site/xdoc/properties.xml?rev=961393&r1=961392&r2=961393&view=diff ============================================================================== --- commons/proper/cli/trunk/src/site/xdoc/properties.xml (original) +++ commons/proper/cli/trunk/src/site/xdoc/properties.xml Wed Jul 7 14:39:27 2010 @@ -28,10 +28,10 @@

The following are the properties that each - Option has. All of these + Option has. All of these can be set using the accessors or using the methods defined in the - OptionBuilder. + OptionBuilder.

Modified: commons/proper/cli/trunk/src/site/xdoc/usage.xml URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/site/xdoc/usage.xml?rev=961393&r1=961392&r2=961393&view=diff ============================================================================== --- commons/proper/cli/trunk/src/site/xdoc/usage.xml (original) +++ commons/proper/cli/trunk/src/site/xdoc/usage.xml Wed Jul 7 14:39:27 2010 @@ -45,7 +45,7 @@

- An + An Options object must be created and the Option must be added to it.

@@ -78,7 +78,7 @@ CommandLine cmd = parser.parse( options,

Now we need to check if the t option is present. To do this we will interrogate the - CommandLine + CommandLine object. The hasOption method takes a java.lang.String parameter and returns true if the option represented by the java.lang.String is present, otherwise @@ -212,11 +212,11 @@ Option find = OptionBuilder.withArg

Now that we have created each - Option we need + Option we need to create the - Options + Options instance. This is achieved using the - addOption + addOption method of Options.

Options options = new Options(); @@ -243,7 +243,7 @@ options.addOption( property );

We now need to create a CommandLineParser. This will parse the command line arguments, using the rules specified by the Options and - return an instance of CommandLine. + return an instance of CommandLine.

public static void main( String[] args ) { // create the parser @@ -274,7 +274,7 @@ if( line.hasOption( "buildfile" ) ) {

CLI also provides the means to automatically generate usage and help information. This is achieved with the - HelpFormatter + HelpFormatter class.

// automatically generate the help statement @@ -328,7 +328,7 @@ Sort entries alphabetically if none of - -C list entries by columns

The following is the code that is used to create the - Options for this example. + Options for this example.

// create the command line parser CommandLineParser parser = new DefaultParser();