Dokumentation

Author: obause

.idea/deploymentTargetDropDown.xml

@@ -40,7 +40,7 @@
  * Über einen RecyclerView werden alle Projekte die dem eingeloggten Nutzer zugeordnet sind, angezeigt.
  * Weiterleitung zur Aufgabenliste ({@link TaskListActivity}) bei Klick auf ein Projekt</p>
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Ole</b>
  * </p>
  */
 

app/src/main/java/de/hochschulehannover/myprojects/AddProject.java

@@ -35,7 +35,7 @@
  * zugeordnet und das Projekt wird anschließend in Firestore aktualisiert
  *</p>
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Ole</b>
  * </p>
  */
 public class AddTask extends BaseActivity {

app/src/main/java/de/hochschulehannover/myprojects/AddTask.java

@@ -25,7 +25,12 @@
 import de.hochschulehannover.myprojects.helper.DBHelper;
 import de.hochschulehannover.myprojects.model.Project;
 
-
+/**
+ * <h2>Fragmentklasse BacklogFragment</h2>
+ *<p>
+ * <b>Autor: Joshua</b>
+ * </p>
+ */
 public class BacklogFragment extends Fragment {
 
     ListView taskListView;

app/src/main/java/de/hochschulehannover/myprojects/BacklogFragment.java

@@ -33,7 +33,7 @@
  * </ul>
  *
  *
- * <b>Autor(en):</b>
+ * <b>Autor: Constantin</b>
  */
 
 public abstract class BaseActivity extends AppCompatActivity {

app/src/main/java/de/hochschulehannover/myprojects/BaseActivity.java

@@ -24,9 +24,11 @@
 import de.hochschulehannover.myprojects.helper.DBHelper;
 
 /**
- * A simple {@link Fragment} subclass.
- * Use the {@link TaskListFragment#newInstance} factory method to
- * create an instance of this fragment.
+ * <h2>Fragmentklasse DoneFragment</h2>
+ *
+ *<p>
+ * <b>Autor: Joshua</b>
+ * </p>
  */
 public class DoneFragment extends Fragment {
 

app/src/main/java/de/hochschulehannover/myprojects/DoneFragment.java

@@ -5,6 +5,13 @@
 import android.os.Bundle;
 import android.widget.TextView;
 
+/**
+ * <h2>Activityklasse FaqActivity</h2>
+ *
+ *<p>
+ * <b>Autor: Constantin</b>
+ * </p>
+ */
 public class FaqActivity extends AppCompatActivity {
     TextView headlineFaqTextView;
     TextView frage1;

app/src/main/java/de/hochschulehannover/myprojects/FaqActivity.java

@@ -24,9 +24,11 @@
 import de.hochschulehannover.myprojects.helper.DBHelper;
 
 /**
- * A simple {@link Fragment} subclass.
- * Use the {@link TaskListFragment#newInstance} factory method to
- * create an instance of this fragment.
+ * <h2>Fragmentklasse InProgressFragment</h2>
+ *
+ *<p>
+ * <b>Autor: Joshua</b>
+ * </p>
  */
 public class InProgressFragment extends Fragment {
 
@@ -37,12 +39,9 @@ public class InProgressFragment extends Fragment {
     static Integer projectId;
     public static Map<String, Integer> map = new HashMap<String, Integer>();
 
-    // TODO: Rename parameter arguments, choose names that match
-    // the fragment initialization parameters, e.g. ARG_ITEM_NUMBER
     private static final String ARG_PARAM1 = "param1";
     private static final String ARG_PARAM2 = "param2";
 
-    // TODO: Rename and change types of parameters
     private String mParam1;
     private String mParam2;
 
@@ -51,15 +50,7 @@ public InProgressFragment(String status) {
         this.mParam1 = status.toString();
     }
 
-    /**
-     * Use this factory method to create a new instance of
-     * this fragment using the provided parameters.
-     *
-     * @param param1 Parameter 1.
-     * @param param2 Parameter 2.
-     * @return A new instance of fragment TaskListFragment.
-     */
-    // TODO: Rename and change types and number of parameters
+
     /*public static TaskListFragment newInstance(String param1, String param2) {
         TaskListFragment fragment = new TaskListFragment();
         Bundle args = new Bundle();

app/src/main/java/de/hochschulehannover/myprojects/InProgressFragment.java

@@ -11,6 +11,13 @@
 import com.google.android.gms.tasks.OnCompleteListener;
 import com.google.firebase.auth.AuthResult;
 
+/**
+ * <h2>Activityklasse FaqActivity</h2>
+ *
+ *<p>
+ * <b>Autor: Constantin</b>
+ * </p>
+ */
 public class InfosActivity extends AppCompatActivity {
 
     TextView headlineTextView;

app/src/main/java/de/hochschulehannover/myprojects/InfosActivity.java

@@ -41,7 +41,7 @@
  * TODO: Klassenname umbenennen. Passt nicht mehr so wirklich.
  * TODO: Google Login in eigene Klasse
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Constantin</b>
  * </p>
  */
 

app/src/main/java/de/hochschulehannover/myprojects/MainActivity.java

@@ -31,6 +31,15 @@
 import de.hochschulehannover.myprojects.model.User;
 import de.hochschulehannover.myprojects.utils.Constants;
 
+/**
+ * <h2>Activity ProfileActivity</h2>
+ *<p>
+ *     Activity zum Anzeigen und bearbeiten der Nutzerdaten. Diese erbt von {@link BaseActivity}.
+ *</p>
+ *<p>
+ * <b>Autor: Constantin (Mit Anpassungen von Ole)</b>
+ * </p>
+ */
 public class ProfileActivity extends BaseActivity {
 
     Toolbar toolbar;

app/src/main/java/de/hochschulehannover/myprojects/ProfileActivity.java

@@ -45,7 +45,7 @@
  * Über einen RecyclerView werden alle Projekte die dem eingeloggten Nutzer zugeordnet sind, angezeigt.
  * Weiterleitung zur Aufgabenliste ({@link TaskListActivity}) bei Klick auf ein Projekt</p>
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Ole</b>
  * </p>
  */
 
@@ -133,7 +133,8 @@ public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
 
     /**
      * Projekte im UI über den RecyclerView anzeigen mit eigener Adapterklasse {@link ProjectAdapter}
-     * @param projectList
+     * @param projectList ArrayList bestehend aus Objekten vom Typ Project. Beinhaltet alle Projekte
+     *                    des Nutzers
      */
     public void projectsToUi (ArrayList<Project> projectList) {
         hideDialog();
@@ -202,8 +203,8 @@ public void updateUserDetails(User user, Boolean readProjectsList) {
      * Diese Methode wird aufgerufen nachdem entweder eine Änderung der Nutzerdaten vorgenommen wurde
      * oder wenn ein neues Projekt angelegt wurde. Je nach Vorgang werden entweder die Nutzerdaten neu
      * vom Firestore geladen oder die Projektliste
-     * @param requestCode
-     * @param resultCode
+     * @param requestCode Der request-Code der beim Aufrufen der Activity übergeben wurde
+     * @param resultCode Der result-Code ob das Ziel der Activity erfolgreich war
      * @param data
      */
     @Override

app/src/main/java/de/hochschulehannover/myprojects/ProjectListActivity.java

@@ -22,6 +22,18 @@
 import de.hochschulehannover.myprojects.model.User;
 import de.hochschulehannover.myprojects.utils.Constants;
 
+/**
+ * <h2>Activityklasse ProjectMembersActivity</h2>
+ *
+ *<p>Liste der Projektmitglieder. Diese erbt von {@link BaseActivity}.
+ * Über einen RecyclerView werden alle Mitglieder angezeigt, die dem aktuell geöffneten Projekt zugeordnet sind, angezeigt.
+ * Bei Klick auf "Mitglied hinzufügen" wird der entsprechende Dialog geöffnet.
+ * </p>
+ *<p>
+ *<p>
+ * <b>Autor: Ole</b>
+ * </p>
+ */
 public class ProjectMembersActivity extends BaseActivity {
 
     private Toolbar toolbar;

app/src/main/java/de/hochschulehannover/myprojects/ProjectMembersActivity.java

@@ -39,7 +39,7 @@
  * registrieren.
  * Weiterleitung zur Projektliste ({@link ProjectListActivity}) nach erfolgreicher Registrierung</p>
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Constantin</b>
  * </p>
  */
 

app/src/main/java/de/hochschulehannover/myprojects/RegisterActivity.java

@@ -13,6 +13,13 @@
 
 import de.hochschulehannover.myprojects.helper.LocaleHelper;
 
+/**
+ * <h2>Activityklasse SettingsActivity</h2>
+ *
+ *<p>
+ * <b>Autor: Constantin</b>
+ * </p>
+ */
 public class SettingsActivity extends AppCompatActivity {
     TextView helloworld,dialog_language;
     int lang_selected;

app/src/main/java/de/hochschulehannover/myprojects/SettingsActivity.java

@@ -28,7 +28,7 @@
  * </ul>
  *
  *
- * <b>Autor(en):</b>
+ * <b>Autor: Joshua</b>
  */
 
 // TODO: Die neue Splash-Screen API benutzen

app/src/main/java/de/hochschulehannover/myprojects/SplashActivity.java

@@ -48,7 +48,7 @@
  * einen RecyclerView mit dem Adapter {@link TaskListAdapter} umgesetzt.
  * </p>
  * <p>
- *  <b>Autor(en):</b>
+ *  <b>Autor: Ole</b>
  * </p>
  */
 

app/src/main/java/de/hochschulehannover/myprojects/TaskListActivity.java

@@ -32,6 +32,7 @@
  * Des weiteren wird in dieser Klasse der entsprechende RecyclerView im Layout initialisiert. An diesen
  * wird dann mithilfe der Adapterklasse {@link TaskListAdapter} die Aufgabenliste für das UI erstellt.
  *
+ * Autor: Joshua (Mit Anpassungen von Ole)
  */
 public class TaskListContentFragment extends Fragment {
 

app/src/main/java/de/hochschulehannover/myprojects/TaskListContentFragment.java

@@ -22,6 +22,13 @@
 import de.hochschulehannover.myprojects.databinding.ActivityTasksByStatusBinding;
 import de.hochschulehannover.myprojects.helper.DBHelper;
 
+/**
+ * <h2>Activityklasse TasksByStatus</h2>
+ *
+ *<p>
+ * <b>Autor: Joshua</b>
+ * </p>
+ */
 public class TasksByStatus extends BaseActivity {
 
     private ActivityTasksByStatusBinding binding;

app/src/main/java/de/hochschulehannover/myprojects/TasksByStatus.java

@@ -27,7 +27,7 @@
  * Sollte der Nutzer bereits eingeloggt sein wir man direkt zur
  * Projektliste ({@link ProjectListActivity}) weitergeleitet</p>
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Joshua</b>
  * </p>
  */
 

app/src/main/java/de/hochschulehannover/myprojects/WelcomeActivity.java

@@ -32,7 +32,7 @@
  * Es werden alle Nutzer die dem Projekt zugeordnet sind für das UI erstellt.
  *
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Ole</b>
  * </p>
  */
 public class MemberListAdapter extends RecyclerView.Adapter<RecyclerView.ViewHolder>{

app/src/main/java/de/hochschulehannover/myprojects/adapter/MemberListAdapter.java

@@ -30,7 +30,7 @@
  * Es werden alle Projekte die dem eingeloggten Nutzer zugeordnet sind für das UI erstellt.
  *
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Ole</b>
  * </p>
  */
 public class ProjectAdapter extends RecyclerView.Adapter<RecyclerView.ViewHolder> {

app/src/main/java/de/hochschulehannover/myprojects/adapter/ProjectAdapter.java

@@ -32,7 +32,7 @@
  * erstellt.
  *
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Ole</b>
  * </p>
  */
 public class TaskListAdapter extends RecyclerView.Adapter<RecyclerView.ViewHolder> {

app/src/main/java/de/hochschulehannover/myprojects/adapter/TaskListAdapter.java

@@ -13,10 +13,6 @@
 
 import de.hochschulehannover.myprojects.R;
 
-/**
- * A [FragmentPagerAdapter] that returns a fragment corresponding to
- * one of the sections/tabs/pages.
- */
 /**
  * <h2>Adapterklasse TaskPagerAdapter</h2>
  *
@@ -28,7 +24,7 @@
  * Das Fragment wird mit dem entsprechenden Tab verbunden bzw. zu diesem Tag hinzugefügt.
  *
  *<p>
- * <b>Autor(en):</b>
+ * <b>Autor: Constantin</b>
  * </p>
  */
 public class TaskPagerAdapter extends FragmentPagerAdapter {

app/src/main/java/de/hochschulehannover/myprojects/adapter/TaskPagerAdapter.java

@@ -3,6 +3,7 @@
 import android.util.Log;
 
 import androidx.annotation.NonNull;
+import androidx.fragment.app.FragmentPagerAdapter;
 
 import com.google.android.gms.tasks.OnCompleteListener;
 import com.google.android.gms.tasks.OnFailureListener;
@@ -30,6 +31,16 @@
 import de.hochschulehannover.myprojects.model.User;
 import de.hochschulehannover.myprojects.utils.Constants;
 
+/**
+ * <h2>Klasse FirestoreClass</h2>
+ *
+ * Diese Klasse ist ausschließlich für die Operationen mit dem Firestore.
+ * Jede Abfrage und jedes Senden von Daten an Firestore erfolgt über diese Klasse.
+ *
+ *<p>
+ * <b>Autor: Ole</b>
+ * </p>
+ */
 public class FirestoreClass {
 
     private String TAG = "FirestoreClass";

app/src/main/java/de/hochschulehannover/myprojects/firebase/FirestoreClass.java

@@ -6,6 +6,12 @@
 
 import androidx.annotation.Nullable;
 
+/**
+ * <h2>Hilfsklasse DBHelper</h2>
+ *<p>
+ * <b>Autor: Joshua</b>
+ * </p>
+ */
 public class DBHelper extends SQLiteOpenHelper {
 
     public DBHelper(Context context) {

app/src/main/java/de/hochschulehannover/myprojects/helper/DBHelper.java

@@ -11,9 +11,11 @@
 import java.util.Locale;
 
 /**
- * Created by abdalla on 10/2/17.
+ * <h2>Hilfsklasse LocaleHelper</h2>
+ *<p>
+ * <b>Autor: Constantin</b>
+ * </p>
  */
-
 public class LocaleHelper {
 
     private static final String SELECTED_LANGUAGE = "Locale.Helper.Selected.Language";

app/src/main/java/de/hochschulehannover/myprojects/helper/LocaleHelper.java

@@ -27,7 +27,7 @@
  *   <li>taskList: Eine ArrayList bestehend aus Objekten vom Typ TaskList. In dieser sind die Aufgabenlisten (Backlog, In Bearbeitung, Fertig) gespeichert</li>
  *  </ul>
  *
- * <b>Autor(en):</b>
+ * <b>Autor: Ole</b>
  * </p>
  */
 public class Project implements Parcelable {