src/org/ibex/plat/package.html

   1 <body>
   2
   3 <p>
   4 Each platform which Ibex is ported to should have a subclass of {@link
   5 org.ibex.Platform} in this package as well as an ant buildfile.
   6 </p>
   7
   8 <p>
   9 The subclass of {@link org.ibex.Platform} should be named
  10 <i>plat</i>.java, where <i>plat</i> is the descriptive name for the
  11 platform. The ant buildfile should be named <i>plat</i>.xml, and
  12 should contain three targets:
  13 </p>
  14
  15 <ul><li> <b><tt>build</tt></b>: compiles all code required for the Ibex
  16          Engine and creates an executable in
  17          <tt>ibex/www/html/dist/</tt>. If applicable, all debugging
  18          symbols should be left in this executable.
  19
  20     <li> <b><tt>run</tt></b>: runs the executable, loading the
  21          <tt>org.ibex.demo.main</tt> widget demo. This is useful for
  22          testing.
  23
  24     <li> <b><tt>dist</tt></b>: prepares any files required to
  25          distribute the engine (for example, a jar or cab). This step
  26          should remove debugging symbols, if applicable.
  27 </ul>
  28
  29 <p>
  30 Other platform-specific files can be included in this directory, as
  31 long as they share the same filename as the main class, and differ
  32 only in extension (for example, <i>plat</i>.cc).
  33 </p>
  34
  35 <p>
  36 Classes in this package may subclass each other; this is useful when
  37 two classes are very similar -- they can share a superclass containing
  38 the common functionality.
  39 </p>
  40
  41 </body>