From 28a9071315dd612eae2d3763fd7b13920f4d6feb Mon Sep 17 00:00:00 2001 From: Steve Loughran Date: Fri, 14 Mar 2003 00:39:54 +0000 Subject: [PATCH] documentation for xdocs to pick up git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@274253 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/tools/ant/taskdefs/ImportTask.java | 23 ++++++++++++++----- 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/src/main/org/apache/tools/ant/taskdefs/ImportTask.java b/src/main/org/apache/tools/ant/taskdefs/ImportTask.java index e0750ae3e..bb22bdb93 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ImportTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/ImportTask.java @@ -62,17 +62,23 @@ import java.io.IOException; import java.util.Vector; /** - * EXPERIMENTAL - * Import task. - * + * EXPERIMENTAL: This task is experimental and may be under continual + * change till Ant1.6 ships; it may even be omitted from the product. + *

+ * Task to import another build file into the current project. + *

* It must be 'top level'. On execution it'll read another file * into the same Project. - * - * Important: there is one limitation related with the top level + *

+ * Important: there is one limitation related to the top level * elements in the imported files. The current implementation will * add them at the end of the top-level ( instead of replacing the * import element - which would be more intuitive ). - * + *

+ * Important: we have not finalized how relative file references + * will be resolved in deep/complex build hierarchies -such as what happens + * when an imported file imports another file. Use absolute references for + * enhanced build file stability. * * @author Nicola Ken Barozzi nicolaken@apache.org * @author Dominique Devienne DDevienne@lgc.com @@ -81,6 +87,11 @@ import java.util.Vector; public class ImportTask extends Task { String file; + /** + * the name of the file to import. How relative paths are resolved is still + * in flux: use absolute paths for safety. + * @param file + */ public void setFile( String file ) { // I don't think we can use File - different rules // for relative paths.