aboutsummaryrefslogtreecommitdiff
path: root/core/src/com/google/inject/package-info.java
diff options
context:
space:
mode:
authormcculls <mcculls@d779f126-a31b-0410-b53b-1d3aecad763e>2010-10-21 19:10:16 +0000
committermcculls <mcculls@d779f126-a31b-0410-b53b-1d3aecad763e>2010-10-21 19:10:16 +0000
commit74d714c1e72bb60706ed9df4d1982971c88c10aa (patch)
treeeacfff9cf6e9d4e60d0dfe9aa4a7b4f9f7a78aeb /core/src/com/google/inject/package-info.java
parent97adab5a1c13e595fb833f3364c60ef972e3fe0d (diff)
downloadguice-74d714c1e72bb60706ed9df4d1982971c88c10aa.tar.gz
Issue 552: (step 1) move core code to its own subdirectory
git-svn-id: https://google-guice.googlecode.com/svn/trunk@1300 d779f126-a31b-0410-b53b-1d3aecad763e
Diffstat (limited to 'core/src/com/google/inject/package-info.java')
-rw-r--r--core/src/com/google/inject/package-info.java47
1 files changed, 47 insertions, 0 deletions
diff --git a/core/src/com/google/inject/package-info.java b/core/src/com/google/inject/package-info.java
new file mode 100644
index 00000000..626bde2b
--- /dev/null
+++ b/core/src/com/google/inject/package-info.java
@@ -0,0 +1,47 @@
+/**
+ * Copyright (C) 2006 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * <i>Google Guice</i> (pronounced "juice") is an ultra-lightweight dependency
+ * injection framework. Please refer to the Guice
+ * <a href="http://docs.google.com/Doc?id=dd2fhx4z_5df5hw8">User's Guide</a>
+ * for a gentle introduction.
+ *
+ * <p>The principal public APIs in this package are:
+ *
+ * <dl>
+ * <dt>{@link com.google.inject.Inject}
+ * <dd>The annotation you will use in your implementation classes to tell Guice
+ * where and how it should send in ("inject") the objects you depend on
+ * (your "dependencies").
+ *
+ * <dt>{@link com.google.inject.Module}
+ * <dd>The interface you will implement in order to specify "bindings" --
+ * instructions for how Guice should handle injection -- for a particular
+ * set of interfaces.
+ *
+ * <dt>{@link com.google.inject.Binder}
+ * <dd>The object that Guice passes into your {@link com.google.inject.Module}
+ * to collect these bindings.
+ *
+ * <dt>{@link com.google.inject.Provider}
+ * <dd>The interface you will implement when you need to customize exactly how
+ * Guice creates instances for a particular binding.
+ *
+ * </dl>
+ *
+ */
+package com.google.inject; \ No newline at end of file