1 2 3 4 5 6 7 8 9 10 11
12 requires xdc.shelf;
13
14 /*!
15 * ======== xdc.services.spec ========
16 *
17 * Java classes to access XDCspec information
18 *
19 * This package contains several Java classes that enable clients to
20 * retrieve inforation about modules, interfaces, and packages from their
21 * specification files (i.e., `*.xdc` files). Being Java classes, the APIs
22 * provided are available to both Java applications and XDCscripts (via the
23 * `$spec` property of the module, interface, or package).
24 *
25 * @p(dlist)
26 * - `{@link ./doc-files/javadoc/xdc/services/spec/Pkg.html [Pkg]}`
27 * Package related information available from a package's
28 * `{@link http://rtsc.eclipse.org/docs/XDCscript_-_Package-Object.undefined4spec $spec}`
29 * property.
30 * - `{@link ./doc-files/javadoc/xdc/services/spec/Unit.html [Unit]}`
31 * Module (or interface) related information available from a
32 * module's (or interface's)
33 * `{@link http://rtsc.eclipse.org/docs/XDCscript_-_Module-Object.undefined4spec $spec}`
34 * property.
35 * @p
36 *
37 * @a(Note)
38 * When accessing the Java methods provided by this package via XDCscript,
39 * you can either either use their liternames (e.g., `getName()`) or use
40 * the JavaBeans pattern of getters and setters in which the method
41 * `getName()` can be accessed via just `name`. The examples below provide
42 * examples of how this pattern can be used.
43 *
44 * @a(XDCscript Examples)
45 * Get the declared name of a module:
46 * @p(code)
47 * var Mod = xdc.module('pkg.Mod');
48 * print("Module declared as " + Mod.$spec.getName());
49 * @p
50 *
51 * This same example can be written using the JavaBean pattern as follows:
52 * @p(code)
53 * var Mod = xdc.module('pkg.Mod');
54 * print("Module declared as " + Mod.$spec.name);
55 * @p
56 *
57 * @see ./doc-files/javadoc/index.html Javadoc
58 */
59 package xdc.services.spec [1, 0, 0] {
60 }
61 62 63
64