2002/03/21 01:19:33
[org.ibex.core.git] / src / org / xwt / plat / package.html
diff --git a/src/org/xwt/plat/package.html b/src/org/xwt/plat/package.html
new file mode 100644 (file)
index 0000000..272a116
--- /dev/null
@@ -0,0 +1,41 @@
+<body>
+
+<p>
+Each platform which XWT is ported to should have a subclass of {@link
+org.xwt.Platform} in this package as well as an ant buildfile.
+</p>
+
+<p>
+The subclass of {@link org.xwt.Platform} should be named
+<i>plat</i>.java, where <i>plat</i> is the descriptive name for the
+platform. The ant buildfile should be named <i>plat</i>.xml, and
+should contain three targets:
+</p>
+
+<ul><li> <b><tt>build</tt></b>: compiles all code required for the XWT
+         Engine and creates an executable in
+         <tt>xwt/www/html/dist/</tt>. If applicable, all debugging
+         symbols should be left in this executable.
+
+    <li> <b><tt>run</tt></b>: runs the executable, loading the
+         <tt>org.xwt.demo.main</tt> widget demo. This is useful for
+         testing.
+
+    <li> <b><tt>dist</tt></b>: prepares any files required to
+         distribute the engine (for example, a jar or cab). This step
+         should remove debugging symbols, if applicable.
+</ul>
+
+<p>
+Other platform-specific files can be included in this directory, as
+long as they share the same filename as the main class, and differ
+only in extension (for example, <i>plat</i>.cc).
+</p>
+
+<p>
+Classes in this package may subclass each other; this is useful when
+two classes are very similar -- they can share a superclass containing
+the common functionality.
+</p>
+
+</body>