donaldp 01/10/17 02:33:23
Modified: src/main/org/apache/tools/ant/taskdefs/condition Os.java
Log:
Added some javadocs for OS condition.
Submitted by: "Jeff Tulley" <[EMAIL PROTECTED]>
Revision Changes Path
1.3 +17 -1
jakarta-ant/src/main/org/apache/tools/ant/taskdefs/condition/Os.java
Index: Os.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/condition/Os.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Os.java 2001/10/13 01:57:03 1.2
+++ Os.java 2001/10/17 09:33:23 1.3
@@ -60,13 +60,29 @@
* Condition that tests the OS type.
*
* @author <a href="mailto:[EMAIL PROTECTED]>Stefan Bodewig</a>
- * @version $Revision: 1.2 $
+ * @version $Revision: 1.3 $
*/
public class Os implements Condition {
private String family;
+ /**
+ * Sets the desired OS family type
+ *
+ * @param f The OS family type desired<br />
+ * Possible values:<br />
+ * <ul><li>dos</li>
+ * <li>mac</li>
+ * <li>netware</li>
+ * <li>unix</li>
+ * <li>windows</li></ul>
+ */
public void setFamily(String f) {family = f.toLowerCase();}
+ /**
+ * Determines if the OS on which Ant is executing matches the type of
+ * that set in setFamily.
+ * @see Os#setFamily(String)
+ */
public boolean eval() throws BuildException {
String osName = System.getProperty("os.name").toLowerCase();
String pathSep = System.getProperty("path.separator");
