From 107521df821d72413751bd6c98ceb71a8a60334b Mon Sep 17 00:00:00 2001 From: Eike Stepper Date: Tue, 24 Oct 2006 08:48:23 +0000 Subject: Added package docs --- .../src/org/eclipse/net4j/message/package.html | 44 +++++++++++++++++++ .../src/org/eclipse/net4j/remote/package.html | 44 +++++++++++++++++++ .../src/org/eclipse/net4j/signal/package.html | 44 +++++++++++++++++++ .../src/org/eclipse/net4j/transport/package.html | 48 +++++++++++++++++++++ .../org/eclipse/net4j/transport/tcp/package.html | 43 +++++++++++++++++++ .../org/eclipse/net4j/transport/util/package.html | 43 +++++++++++++++++++ .../org/eclipse/net4j/util/concurrent/package.html | 43 +++++++++++++++++++ .../org/eclipse/net4j/util/lifecycle/package.html | 45 +++++++++++++++++++ .../src/org/eclipse/net4j/util/package.html | 43 +++++++++++++++++++ .../org/eclipse/net4j/util/registry/package.html | 50 ++++++++++++++++++++++ .../src/org/eclipse/net4j/util/stream/package.html | 43 +++++++++++++++++++ 11 files changed, 490 insertions(+) create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html create mode 100644 plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/stream/package.html (limited to 'plugins/org.eclipse.net4j') diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html new file mode 100644 index 0000000000..6317e595ff --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/message/package.html @@ -0,0 +1,44 @@ + + + + + + + +A framework for publish/subscribe based communication on top of +the Net4j transport layer. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html new file mode 100644 index 0000000000..59314891be --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/remote/package.html @@ -0,0 +1,44 @@ + + + + + + + +A framework for exporting and importing services on top of +the Net4j transport layer. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html new file mode 100644 index 0000000000..671fb2d8d2 --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html @@ -0,0 +1,44 @@ + + + + + + + +A framework for request/response based communication on top of +the Net4j transport layer. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html new file mode 100644 index 0000000000..710815a838 --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/package.html @@ -0,0 +1,48 @@ + + + + + + + +The transport layer of the Net4j API. +The four main interfaces of the transport layer are +{@link org.eclipse.net4j.transport.Buffer}, +{@link org.eclipse.net4j.transport.Channel}, +{@link org.eclipse.net4j.transport.Connector} and +{@link org.eclipse.net4j.transport.Protocol}. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html new file mode 100644 index 0000000000..540d8b726b --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/tcp/package.html @@ -0,0 +1,43 @@ + + + + + + + +Interfaces for the transport layer specialized for TCP socket connections. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html new file mode 100644 index 0000000000..6fc006eed2 --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/transport/util/package.html @@ -0,0 +1,43 @@ + + + + + + + +Stream classes for the transport layer. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html new file mode 100644 index 0000000000..df23882ade --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/concurrent/package.html @@ -0,0 +1,43 @@ + + + + + + + +Utility interfaces and classes commonly useful in concurrent programming. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html new file mode 100644 index 0000000000..2debae61bf --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/lifecycle/package.html @@ -0,0 +1,45 @@ + + + + + + + +Interfaces that describe the behaviour of objects with respect to their lifecycle. +A utility class to interact with such objects and an abstract class that can be +used to implement such objects are provided as well. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html new file mode 100644 index 0000000000..0e89bc3c5b --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/package.html @@ -0,0 +1,43 @@ + + + + + + + +Utility classes. +

+ + + + + + + diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html new file mode 100644 index 0000000000..b596cc363c --- /dev/null +++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/util/registry/package.html @@ -0,0 +1,50 @@ + + + + + + + +Interfaces and classes for general purpose registries. +A registry is like a Map but has some additional features: +

It provides a descriptor framework for registry elements that + are to be instantiated lazily +
It provides a notification framework that enables clients to + react on events (including the resolution of a lazy descriptor) +