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 `$spec`
28 * property.
29 * - `{@link ./doc-files/javadoc/xdc/services/spec/Unit.html [Unit]}`
30 * Module (or interface) related information available from a
31 * module's (or interface's) `$spec` property.
32 * @p
33 *
34 * @a(Note)
35 * When accessing the Java methods provided by this package via XDCscript,
36 * you can either either use their liternames (e.g., `getName()`) or use
37 * the JavaBeans pattern of getters and setters in which the method
38 * `getName()` can be accessed via just `name`. The examples below provide
39 * examples of how this pattern can be used.
40 *
41 * @a(XDCscript Examples)
42 * Get the declared name of a module:
43 * @p(code)
44 * var Mod = xdc.module('pkg.Mod');
45 * print("Module declared as " + Mod.$spec.getName());
46 * @p
47 *
48 * This same example can be written using the JavaBean pattern as follows:
49 * @p(code)
50 * var Mod = xdc.module('pkg.Mod');
51 * print("Module declared as " + Mod.$spec.name);
52 * @p
53 *
54 * @see ./doc-files/javadoc/index.html Javadoc
55 */
56 package xdc.services.spec [1, 0, 0, 0] {
57
58 }
59 60 61
62