You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ro...@apache.org on 2004/12/27 19:17:06 UTC

cvs commit: jakarta-commons/cli/xdocs/examples index.xml

roxspring    2004/12/27 10:17:06

  Modified:    cli/xdocs/examples index.xml
  Log:
  Added examples overview documentation
  
  Revision  Changes    Path
  1.2       +14 -1     jakarta-commons/cli/xdocs/examples/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/cli/xdocs/examples/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	2 Sep 2004 13:58:16 -0000	1.1
  +++ index.xml	27 Dec 2004 18:17:06 -0000	1.2
  @@ -23,7 +23,20 @@
   
     <body>
       <section name="Overview">
  -      <p>TODO quick overview to the examples</p>
  +      <p>
  +        The examples section aims to show how a variety of applications and 
  +        tools could be modelled using CLI2.  We make no claim that these tools 
  +        use CLI2 in their implementation but simply use their interfaces to 
  +        demonstrate commonly needed features.  Some examples will make 
  +        simplifications to keep the documentation consise.
  +      </p>
  +      <p>
  +        Many aspects of the API are touched upon but few are described in 
  +        great detail.  If more information is required then the reader is 
  +        encouraged to review the API documentation and look at the unit tests 
  +        for inspiration.  Failing that, further advice and discussion can be 
  +        found on the <code>commons-user@jakarta.apache.org</code> mailing list.
  +      </p>
       </section>
     </body>
   </document>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org