Home | History | Annotate | Download | only in dagger
      1 /*
      2  * Copyright (C) 2015 Google, Inc.
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  * http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 /**
     18  * This package contains the public API for the <a href="http://google.github.io/dagger/">Dagger
     19  * 2</a> dependency injection framework.  By building upon
     20  * <a href="https://jcp.org/en/jsr/detail?id=330">JSR 330</a>, Dagger 2 provides an
     21  * annotation-driven API for dependency injection whose implementation is entirely generated at
     22  * compile time by <a href="http://en.wikipedia.org/wiki/Java_annotation#Processing">annotation
     23  * processors</a>.
     24  *
     25  * <p>The entry point into the API is the {@link Component}, which annotates abstract types for
     26  * Dagger 2 to implement.  The dependency graph is configured using using annotations such as
     27  * {@link Module}, {@link Provides} and {@link javax.inject.Inject}.
     28  *
     29  * <p>{@code dagger.internal.codegen.ComponentProcessor} is the processor responsible for generating
     30  * the implementation.  Dagger uses the annotation procesor
     31  * {@linkplain java.util.ServiceLoader service loader} to automatically configure the processor, so
     32  * explict build configuration shouldn't be necessary.
     33  */
     34 package dagger;
     35