Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/standard
In directory sc8-pr-cvs1:/tmp/cvs-serv27988/src/documentation/content/xdocs/standard
Modified Files:
index.xml
Log Message:
Document updates for ant tasks
Index: index.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/standard/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** index.xml 9 Feb 2003 13:47:15 -0000 1.1
--- index.xml 12 Feb 2003 20:51:48 -0000 1.2
***************
*** 36,44 ****
For package <strong>"personal.my.stuff"</strong> the class naming convention allows:</p>
<table>
! <tr><th>Primary Search Location</th><td>personal.my.stuff.version.Version</td></tr>
! <tr><th>Secondary Search Location</th><td>personal.my.stuff.Version</td></tr>
</table>
<p>
! {primary package path}.version.Version.class
</p>
<p>Notes:</p>
--- 36,44 ----
For package <strong>"personal.my.stuff"</strong> the class naming convention allows:</p>
<table>
! <tr><th>Primary Search Location</th><td><code>personal.my.stuff.version.Version</code></td></tr>
! <tr><th>Secondary Search Location</th><td><code>personal.my.stuff.Version</code></td></tr>
</table>
<p>
! <code>{primary package path}.version.Version.class</code>
</p>
<p>Notes:</p>
***************
*** 55,98 ****
A single method or public field
</p>
! <table>
! <tr>
! <th>
! Option #1: Simple <strong>Field</strong>
! </th>
! <td>
! <code>
public static final String VERSION = "1.1.1-alpha";
! </code>
! </td>
! </tr>
! <tr>
! <th>
! Option #2: Simple <strong>Method</strong>
! </th>
! <td>
! <code>
public String getVersion();
! </code>
! </td>
! </tr>
! <tr>
! <th>
! Option #3: <strong>Compound Method</strong> (Beaner)
! </th>
! <td>
! <code>
public int getMajor();
public int getMinor();
public String getReleaseLevel();
public int getPoint();
! </code>
! </td>
! </tr>
! </table>
! <p>Notes:</p>
! <ul>
! <li>Choices are support to allow for developer preferences and/or tooling implementations.</li>
! <li>Extension interfaces (signatures) are allowed (to describe location, or add attributes) but these are 100% optional.</li>
! </ul>
</section>
<section><title>Version Formats</title>
--- 55,78 ----
A single method or public field
</p>
! <section><title>Option #1: Simple Field</title>
! <source>
public static final String VERSION = "1.1.1-alpha";
! </source>
! </section>
! <section><title>Option #2: Simple Method</title>
! <source>
public String getVersion();
! </source>
! </section>
! <section><title>Option #3: Compound Method (Beaner)</title>
! <source>
public int getMajor();
public int getMinor();
public String getReleaseLevel();
public int getPoint();
! </source>
! </section>
! <note>Choices are support to allow for developer preferences and/or tooling implementations.</note>
! <note>Extension interfaces (signatures) are allowed (to describe location, or add attributes) but these are 100% optional.</note>
</section>
<section><title>Version Formats</title>
***************
*** 104,108 ****
<section><title>Appendix -- Examples</title>
<section><title>Example #1: Simple 'Field' Form</title>
! <p><code>
package personal.my.stuff.version;
--- 84,88 ----
<section><title>Appendix -- Examples</title>
<section><title>Example #1: Simple 'Field' Form</title>
! <source>
package personal.my.stuff.version;
***************
*** 112,121 ****
public static final String VERSION_STRING = "3.0.1-beta";
}
! </code>
! </p>
</section>
<section><title>Example #2: Explicit Simple 'Field' Form</title>
! <p>
! <code>
package personal.my.stuff.version;
--- 92,99 ----
public static final String VERSION_STRING = "3.0.1-beta";
}
! </source>
</section>
<section><title>Example #2: Explicit Simple 'Field' Form</title>
! <source>
package personal.my.stuff.version;
***************
*** 131,139 ****
public static final String VERSION_STRING = "3.0.1-beta";
}
! </code>
! </p>
</section>
<section><title>Example #3: Simple Method Form</title>
! <p><code>
package personal.my.stuff.version;
--- 109,116 ----
public static final String VERSION_STRING = "3.0.1-beta";
}
! </source>
</section>
<section><title>Example #3: Simple Method Form</title>
! <source>
package personal.my.stuff.version;
***************
*** 142,149 ****
public getVersion() { return "3.0.1-beta"; }
}
! </code></p>
</section>
<section><title>Example #3: Compound Form</title>
! <p><code>
package personal.my.stuff.version;
--- 119,126 ----
public getVersion() { return "3.0.1-beta"; }
}
! </source>
</section>
<section><title>Example #3: Compound Form</title>
! <source>
package personal.my.stuff.version;
***************
*** 156,161 ****
public int getPoint(){ return 1; }
}
!
! </code></p>
</section>
</section>
--- 133,137 ----
public int getPoint(){ return 1; }
}
! </source>
</section>
</section>
***************
*** 168,172 ****
To allow the addition of "arbitrary" pices on information (such as build date, build user) the "Attribute" extension is allowed.
</p>
! <p><code>
public HashMap getAttributes()
{
--- 144,148 ----
To allow the addition of "arbitrary" pices on information (such as build date, build user) the "Attribute" extension is allowed.
</p>
! <source>
public HashMap getAttributes()
{
***************
*** 179,184 ****
return attributes;
}
! </code>
! </p></section>
</section>
<section><title>References</title>
--- 155,160 ----
return attributes;
}
! </source>
! </section>
</section>
<section><title>References</title>
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.