From 8ed37ce3c4e03eca994719283ba1a12b4207f65d Mon Sep 17 00:00:00 2001
From: Fernando Cejas <fcejas@gmail.com>
Date: Mon, 23 Mar 2015 23:18:34 +0100
Subject: [PATCH] Add documentation to dependency injection components and
 modules.

---
 .../sample/presentation/internal/di/HasComponent.java         | 3 +++
 .../presentation/internal/di/components/UserComponent.java    | 4 ++++
 .../sample/presentation/internal/di/modules/UserModule.java   | 3 +++
 3 files changed, 10 insertions(+)

diff --git a/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/HasComponent.java b/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/HasComponent.java
index 6c11606..5ec2a2e 100644
--- a/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/HasComponent.java
+++ b/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/HasComponent.java
@@ -4,6 +4,9 @@
  */
 package com.fernandocejas.android10.sample.presentation.internal.di;
 
+/**
+ * Interface representing a contract for clients that contains a component for dependency injection.
+ */
 public interface HasComponent<C> {
   C getComponent();
 }
diff --git a/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/components/UserComponent.java b/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/components/UserComponent.java
index 74617c1..406f585 100644
--- a/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/components/UserComponent.java
+++ b/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/components/UserComponent.java
@@ -11,6 +11,10 @@ import com.fernandocejas.android10.sample.presentation.view.fragment.UserDetails
 import com.fernandocejas.android10.sample.presentation.view.fragment.UserListFragment;
 import dagger.Component;
 
+/**
+ * A scope {@link com.fernandocejas.android10.sample.presentation.internal.di.PerActivity} component.
+ * Injects user specific Fragments.
+ */
 @PerActivity
 @Component(dependencies = ApplicationComponent.class, modules = {ActivityModule.class, UserModule.class})
 public interface UserComponent extends ActivityComponent {
diff --git a/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/modules/UserModule.java b/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/modules/UserModule.java
index 3569017..d6dc236 100644
--- a/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/modules/UserModule.java
+++ b/presentation/src/main/java/com/fernandocejas/android10/sample/presentation/internal/di/modules/UserModule.java
@@ -12,6 +12,9 @@ import com.fernandocejas.android10.sample.presentation.internal.di.PerActivity;
 import dagger.Module;
 import dagger.Provides;
 
+/**
+ * Dagger module that provides user related collaborators.
+ */
 @Module
 public class UserModule {
   @Provides @PerActivity GetUserListUseCase provideGetUserListUseCase(GetUserListUseCaseImpl getUserListUseCase) {