Mercurial > hg > release > thermostat-1.0
changeset 1364:de7fe0a6a382
Explicitly describe all of public API
Reviewed-by: neugens, vanaltj
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-November/008938.html
author | Omair Majid <omajid@redhat.com> |
---|---|
date | Mon, 25 Nov 2013 15:44:21 -0500 |
parents | cf184d4064b2 |
children | bfe135192880 |
files | README README.api pom.xml |
diffstat | 3 files changed, 68 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/README Mon Nov 25 12:34:34 2013 -0500 +++ b/README Mon Nov 25 15:44:21 2013 -0500 @@ -13,7 +13,8 @@ 3.1.1 PASSING JVM SPECIFIC OPTIONS 3.1.2 GNOME KEYRING 3.2 RUNNING THERMOSTAT ECLIPSE -4. REFERECES +4. EXTENDING THERMOSTAT +5. REFERENCES -------------------------------------------------------------------------------- @@ -188,7 +189,12 @@ -------------------------------------------------------------------------------- -4. REFERECES +4. EXTENDING THERMOSTAT + +The README.api file contains a list of public/support API of thermostat. + +-------------------------------------------------------------------------------- +5. REFERENCES User Guide: http://icedtea.classpath.org/wiki/Thermostat/UserGuide
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.api Mon Nov 25 15:44:21 2013 -0500 @@ -0,0 +1,59 @@ +Public API +========== + +The public supported API of thermostat consists of the following packages: + + - com.redhat.thermostat.agent + - com.redhat.thermostat.agent.command + - com.redhat.thermostat.agent.config + - com.redhat.thermostat.annotations + - com.redhat.thermostat.backend + - com.redhat.thermostat.client.cli + - com.redhat.thermostat.client.command + - com.redhat.thermostat.client.core + - com.redhat.thermostat.client.core.controllers + - com.redhat.thermostat.client.core.progress + - com.redhat.thermostat.client.core.views + - com.redhat.thermostat.client.swing + - com.redhat.thermostat.client.swing.components + - com.redhat.thermostat.client.swing.components.models + - com.redhat.thermostat.client.ui + - com.redhat.thermostat.common + - com.redhat.thermostat.common.cli + - com.redhat.thermostat.common.command + - com.redhat.thermostat.common.config + - com.redhat.thermostat.common.model + - com.redhat.thermostat.common.ssl + - com.redhat.thermostat.common.tools + - com.redhat.thermostat.common.utils + - com.redhat.thermostat.launcher + - com.redhat.thermostat.plugin.validator + - com.redhat.thermostat.service.process + - com.redhat.thermostat.shared.config + - com.redhat.thermostat.shared.locale + - com.redhat.thermostat.storage.config + - com.redhat.thermostat.storage.core + - com.redhat.thermostat.storage.core.auth + - com.redhat.thermostat.storage.dao + - com.redhat.thermostat.storage.model + - com.redhat.thermostat.storage.monitor + - com.redhat.thermostat.storage.query + - com.redhat.thermostat.utils + - com.redhat.thermostat.utils.hostname + - com.redhat.thermostat.utils.keyring + - com.redhat.thermostat.utils.management + - com.redhat.thermostat.utils.username + + + +Internal API +------------ + +A number of packages are public (either OSGi or not) but should be considered +internal. + + - c.r.t.main + - c.r.t.*.experimental (and subpackages) + - c.r.t.storage.mongodb (and subpackages) + - c.r.t.web (and subpackages) + - c.r.t.client.filter.vm.core
--- a/pom.xml Mon Nov 25 12:34:34 2013 -0500 +++ b/pom.xml Mon Nov 25 15:44:21 2013 -0500 @@ -221,7 +221,7 @@ <artifactId>maven-javadoc-plugin</artifactId> <version>2.9.1</version> <configuration> - <excludePackageNames>*.impl*;*.internal.*;com.redhat.thermostat.agent.locale;com.redhat.thermostat.agent.proxy.server;com.redhat.thermostat.backend.system;com.redhat.thermostat.client.command.cli;com.redhat.thermostat.client.filter.host.swing;com.redhat.thermostat.client.filter.vm.swing;com.redhat.thermostat.common.locale;com.redhat.thermostat.numa;com.redhat.thermostat.plugin.validator.locale;com.redhat.thermostat.test;com.redhat.thermostat.testutils;com.redhat.thermostat.utils.keyring.activator;com.redhat.thermostat.vm;com.redhat.thermostat.host;com.redhat.thermostat.gc;com.redhat.thermostat.thread;com.redhat.thermostat.validate;com.redhat.thermostat.service.activator;com.redhat.thermostat.killvm.client.locale</excludePackageNames> + <excludePackageNames>*.impl*;*.internal.*;*.experimental;com.redhat.thermostat.agent.locale;com.redhat.thermostat.agent.proxy;com.redhat.thermostat.backend.system;com.redhat.thermostat.client.command.cli;com.redhat.thermostat.client.filter.host.swing;com.redhat.thermostat.client.filter.vm.core;com.redhat.thermostat.client.filter.vm.swing;com.redhat.thermostat.client.locale;com.redhat.thermostat.common.locale;com.redhat.thermostat.main;com.redhat.thermostat.numa;com.redhat.thermostat.plugin.validator.locale;com.redhat.thermostat.storage.mongodb;com.redhat.thermostat.test;com.redhat.thermostat.testutils;com.redhat.thermostat.utils.keyring.activator;com.redhat.thermostat.vm;com.redhat.thermostat.host;com.redhat.thermostat.gc;com.redhat.thermostat.thread;com.redhat.thermostat.validate;com.redhat.thermostat.service.activator;com.redhat.thermostat.web;com.redhat.thermostat.killvm.client.locale</excludePackageNames> <debug>true</debug> </configuration> </plugin>