dflorey 2004/10/15 10:34:12
Modified: contract/xdocs navigation.xml index.xml
Added: contract/xdocs quickstart.xml
Log:
Started documentation
Revision Changes Path
1.3 +1 -1 jakarta-commons-sandbox/contract/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/contract/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 15 Oct 2004 11:11:41 -0000 1.2
+++ navigation.xml 15 Oct 2004 17:34:12 -0000 1.3
@@ -5,7 +5,7 @@
<body>
<menu name="Commons Transaction">
<item name="Overview" href="/index.html" />
-<!-- <item name="Quickstart" href="/quickstart.html" /> -->
+ <item name="Getting started" href="/quickstart.html" />
<!-- <item name="Configuration"
href="/configuration.html" /> -->
<!--
<item name="Developers Guide" href="/guide/index.html"
collapse="true">
1.2 +4 -0 jakarta-commons-sandbox/contract/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/contract/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 8 Oct 2004 09:36:18 -0000 1.1
+++ index.xml 15 Oct 2004 17:34:12 -0000 1.2
@@ -14,6 +14,10 @@
The contract component delivers the contract based programming core that is
currently used
in the Slide Projector project.
</p>
+<p>
+This component makes all the nice features available to the java programming
language that
+come along with contract based programming.
+</p>
</section>
<section name="Releases">
1.1 jakarta-commons-sandbox/contract/xdocs/quickstart.xml
Index: quickstart.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Getting started</title>
<author email="[EMAIL PROTECTED]">Commons Documentation Team</author>
</properties>
<body>
<section name="Getting started">
<p>In order to get an impression of how this component works, we will start with an
example showing the capabilities of this package.</p>
<p>To get started you need at least the jar of this component and the dependent
i18n.jar in your classpath.</p>
</section>
<section name="What is contract based programming?">
<p>You already know contract based programming if you've ever implemented a java
method: You specify
a contract that defines which types of parameters are accepted by your method. This
is how a method
might look like:</p>
<source>
public float calculateSpeed(float distance, float time, String unit) {
...calculate speed...
return speed;
}
</source>
<p>So your method will accept two floats that pass the distance and the time to the
method. Additionally
the method requires the unit in which the time was measured. You can tell this
by using the appropriated
types, that reflect the desired values. But you cannot declare, which value
ranges are valid for your
method. You might only accept values larger than zero for the time and only
"s", "min" and "h" for the
unit.</p>
<p>To get started you need at least the jar of this component and the
dependent i18n.jar in your classpath.</p>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
