From 7b664ba28c7b3d58005933148adb5119dae3d98a Mon Sep 17 00:00:00 2001
From: MichaelFlisar <mflisar85@gmail.com>
Date: Mon, 13 Feb 2017 12:27:24 +0100
Subject: [PATCH] code documentation added for the builders

---
 README.md                                     | 13 +--
 .../com/michaelflisar/lumberjack/demo/L.java  | 13 +--
 .../lumberjack/demo/MainActivity.java         | 33 ++++++--
 .../app/src/main/res/layout/activity_main.xml |  7 ++
 .../lumberjack/FileLoggingSetup.java          | 46 ++++++++++
 .../lumberjack/NotificationLoggingSetup.java  | 58 ++++++++++++-
 .../lumberjack/OverlayLoggingSetup.java       | 84 ++++++++++++++++---
 .../src/main/res/layout/overlay.xml           |  4 +-
 8 files changed, 225 insertions(+), 33 deletions(-)

diff --git a/README.md b/README.md
index 9596aa5..4f50ea3 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,8 @@ dependencies {
     // modules (OPTIONAL)
     compile 'com.github.MFlisar.Lumberjack:lumberjack-filelogger:1.3'
     compile 'com.github.MFlisar.Lumberjack:lumberjack-notification:1.3'
+	debugCompile project(':lumberjack-overlay')
+    releaseCompile project(':lumberjack-overlay-noop')
     
     // ALTERNATIVELY you can add ALL modules at once like following
     // compile 'com.github.MFlisar:Lumberjack:1.3'
@@ -43,7 +45,7 @@ dependencies {
 
 ###Example
 
-This is what the demo setup will print out (to your file, to the notification, to console). It has pretty printing enabled and prints first 5 values of an array automatically. It as well prints caller class and group combined as tag. The demo shows that
+This is what the demo setup will print out (to your file, to the notification, to console, to the overlay). It has pretty printing enabled and prints first 5 values of an array automatically. It as well prints caller class and group combined as tag. The demo shows that
 
 * arrays are printed automatically
 * custom classes are automatically formatter to the custom formatter you have registered, no matter if the classes are printed inside an array or as a simple value
@@ -95,8 +97,7 @@ The overlay logger is based on Hannes Dorfmann's DebugOverlay: https://github.co
 ###Missing
 
 * Notification Logger
-  * An activity that can be launched via the notification (that shows the logs and offers advanced filter options)
-  * filter: errors only
-  * overlay logger
-  * demo gif
-  * noop für overlay logger to avoid the overlay manifest permission
\ No newline at end of file
+	* An activity that can be launched via the notification (that shows the logs and offers advanced filter options)
+	* filter: errors only
+ * Overlay Logger
+	* filter: errors only
\ No newline at end of file
diff --git a/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/L.java b/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/L.java
index 16c84cf..20f8e54 100644
--- a/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/L.java
+++ b/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/L.java
@@ -61,8 +61,8 @@ public String log(MainActivity.TestClass item, boolean logInList) {
         });
 
         // some test logs...
-        L.d(G_TEST, "initLumberjack fertig");
-        L.d(G_TEST, "LogFiles: %s", FileLoggingUtil.getAllExistingLogFiles(FILE_LOG_SETUP));
+        L.d(G_TEST1, "initLumberjack fertig");
+        L.d(G_TEST2, "LogFiles: %s", FileLoggingUtil.getAllExistingLogFiles(FILE_LOG_SETUP));
     }
 
     public static void initOverlayLogger(Activity activity)
@@ -78,7 +78,7 @@ public static void handleOverlayPermissionDialogResult(int requestCode, int resu
         // we know that the 4th tree is the overlay logger, so we just hand on the data
         boolean success = ((OverlayLoggingTree)Timber.forest().get(3)).checkRequestPermissionResult(requestCode, resultCode, data);
 
-        L.d(G_TEST, "Overlay permission granted: %b", success);
+        L.d(G_TEST1, "Overlay permission granted: %b", success);
     }
 
     // -----------------------------
@@ -86,11 +86,13 @@ public static void handleOverlayPermissionDialogResult(int requestCode, int resu
     // -----------------------------
 
     // Groups
-    public static final ILogGroup G_TEST = L.createGroup("TEST-GROUP");
+    public static final ILogGroup G_TEST1 = L.createGroup("TEST-GROUP 1");
+    public static final ILogGroup G_TEST2 = L.createGroup("TEST-GROUP 2");
 
     public static final ArrayList<ILogGroup> LOG_GROUPS = new ArrayList<ILogGroup>() {
         {
-            add(G_TEST);
+            add(G_TEST1);
+            add(G_TEST2);
         }
     };
 
@@ -108,6 +110,7 @@ public static void handleOverlayPermissionDialogResult(int requestCode, int resu
             .withTitle("Demo Logger")
             //.withBigIcon(R.mipmap.ic_launcher_default)
             .withNotificationId(150)
+            .withButtonIntentRequestCodeBase(250)
             .withFilters(LOG_GROUPS);
 
     // -----------------------------
diff --git a/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/MainActivity.java b/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/MainActivity.java
index e49b5a8..27170b5 100644
--- a/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/MainActivity.java
+++ b/demo/app/src/main/java/com/michaelflisar/lumberjack/demo/MainActivity.java
@@ -3,17 +3,24 @@
 import android.content.Intent;
 import android.support.v7.app.AppCompatActivity;
 import android.os.Bundle;
+import android.view.View;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 
-public class MainActivity extends AppCompatActivity {
+public class MainActivity extends AppCompatActivity implements View.OnClickListener {
 
+    private int mCount = 0;
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
 
+        if (savedInstanceState != null)
+            mCount = savedInstanceState.getInt("mCount");
+
+        findViewById(R.id.btLog).setOnClickListener(this);
+
         // here we can ask for the permission, so we init the overlay logger in here
         // make sure to pass on the result of the permission dialog to the overlay logger!
         L.initOverlayLogger(this);
@@ -30,13 +37,13 @@ protected void onCreate(Bundle savedInstanceState) {
         L.d("Test array log: %s", new ArrayList<>(Arrays.asList("array value 1", "array value 2")));
 
         // Test 3: a few logs with usage of groups
-        L.d(L.G_TEST, "Test message in test group");
-        L.d(L.G_TEST, "Test message in test group, value=%d", 999);
+        L.d(L.G_TEST1, "Test message in test group");
+        L.d(L.G_TEST1, "Test message in test group, value=%d", 999);
 
         // Test 4: Disable a group, log to this group and see, that nothing is logged and enable group again
-        L.disableLogGroup(L.G_TEST);
-        L.e(L.G_TEST, "This message should NOT appear anywhere because the group is disabled!");
-        L.enableLogGroup(L.G_TEST);
+        L.disableLogGroup(L.G_TEST1);
+        L.e(L.G_TEST1, "This message should NOT appear anywhere because the group is disabled!");
+        L.enableLogGroup(L.G_TEST1);
 
         // Test 5 - custom object formatting
         // we have registered a custom formatter for our TestClass, so we can DIRECTLY pass TestClasses for any string paramter and lumberjack will take care of it!
@@ -50,6 +57,20 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
         super.onActivityResult(requestCode, resultCode, data);
     }
 
+    @Override
+    public void onSaveInstanceState(Bundle outState)
+    {
+        super.onSaveInstanceState(outState);
+        outState.putInt("mCount", mCount);
+    }
+
+    @Override
+    public void onClick(View view)
+    {
+        mCount++;
+        L.d("Button clicked: %d", mCount);
+    }
+
     public static class TestClass
     {
         public int x;
diff --git a/demo/app/src/main/res/layout/activity_main.xml b/demo/app/src/main/res/layout/activity_main.xml
index c165f71..a942d69 100644
--- a/demo/app/src/main/res/layout/activity_main.xml
+++ b/demo/app/src/main/res/layout/activity_main.xml
@@ -14,4 +14,11 @@
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:text="Hello World!" />
+
+    <Button
+        android:id="@+id/btLog"
+        android:layout_centerInParent="true"
+        android:text="Add log message"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"/>
 </RelativeLayout>
diff --git a/library-filelogger/src/main/java/com/michaelflisar/lumberjack/FileLoggingSetup.java b/library-filelogger/src/main/java/com/michaelflisar/lumberjack/FileLoggingSetup.java
index fe4853b..76a2844 100644
--- a/library-filelogger/src/main/java/com/michaelflisar/lumberjack/FileLoggingSetup.java
+++ b/library-filelogger/src/main/java/com/michaelflisar/lumberjack/FileLoggingSetup.java
@@ -34,42 +34,88 @@ public FileLoggingSetup(Context context)
         mFolder = context.getFileStreamPath("").getAbsolutePath();
     }
 
+    /**
+     * define a custom path for the folder, in which you want to create your log files
+     * DEFAULT: the apps cache directory
+     *
+     * @param folderPath The path of the folder
+     */
     public FileLoggingSetup withFolder(String folderPath)
     {
         mFolder = folderPath;
         return this;
     }
 
+    /**
+     * define a custom basic file name for your log files
+     * DEFAULT: log
+     *
+     * @param fileName The basic file name of your log files
+     */
     public FileLoggingSetup withFileName(String fileName)
     {
         mFileName = fileName;
         return this;
     }
 
+    /**
+     * define a custom file extension for your log files
+     * DEFAULT: log
+     *
+     * @param fileExtension The file extension of your log files
+     */
     public FileLoggingSetup withFileExtension(String fileExtension)
     {
         mFileExtension = fileExtension;
         return this;
     }
 
+    /**
+     * define a custom log file pattern
+     * DEFAULT: 7
+     *
+     * @param logsToKeep number of log files to keep
+     */
     public FileLoggingSetup withLogsToKeep(int logsToKeep)
     {
         mLogsToKeep = logsToKeep;
         return this;
     }
 
+    /**
+     * define a custom file logger format
+     * Refer to https://github.com/tony19/logback-android and https://www.slf4j.org/ for more infos
+     * DEFAULT: %d{HH:mm:ss.SSS}	%logger{36}	%msg%n
+     *
+     * @param pattern the log pattern
+     */
     public FileLoggingSetup withPattern(String pattern)
     {
         mLogPattern = pattern;
         return this;
     }
 
+    /**
+     * define the mode you want to use
+     * Select between {@link Mode#DateFiles} and {@link Mode#NumberedFiles}
+     * {@link Mode#DateFiles} will create a log file per day
+     * {@link Mode#NumberedFiles} will create a new log file after the size defined via {@link FileLoggingSetup#withNumberedFileSizeLimit(String)} is reached
+     *
+     * @param mode the mode you want
+     */
     public FileLoggingSetup withMode(Mode mode)
     {
         mMode = mode;
         return this;
     }
 
+    /**
+     * define the size limit for the file logger with mode {@link Mode#NumberedFiles}
+     * you can use 1KB, 1MB and similar strings
+     * DEFAULT: 1MB
+     *
+     * @param size the size
+     */
     public FileLoggingSetup withNumberedFileSizeLimit(String size)
     {
         mNumberedFileSizeLimit = size;
diff --git a/library-notification/src/main/java/com/michaelflisar/lumberjack/NotificationLoggingSetup.java b/library-notification/src/main/java/com/michaelflisar/lumberjack/NotificationLoggingSetup.java
index 0f2a908..1eb27ef 100644
--- a/library-notification/src/main/java/com/michaelflisar/lumberjack/NotificationLoggingSetup.java
+++ b/library-notification/src/main/java/com/michaelflisar/lumberjack/NotificationLoggingSetup.java
@@ -24,54 +24,108 @@ public class NotificationLoggingSetup
     Integer mVibrationLogLevel = null;
     Integer mBeepLogLevel = null;
 
+    /**
+     * Constructor of the setup
+     *
+     * @param smallIcon the small notification icon
+     */
     public NotificationLoggingSetup(int smallIcon)
     {
         mSmallIcon = smallIcon;
     }
 
+    /**
+     * define a custom notification title
+     * DEFAULT: Logger
+     *
+     * @param title the notification title
+     */
     public NotificationLoggingSetup withTitle(String title)
     {
         mTitle = title;
         return this;
     }
 
+    /**
+     * define a custom big notification icon
+     * DEFAULT: NONE
+     *
+     * @param icon the big notification icon
+     */
     public NotificationLoggingSetup withBigIcon(int icon)
     {
         mBigIcon = icon;
         return this;
     }
 
+    /**
+     * define a custom notification id to avoid problems with multiple loggers or other notifications
+     * DEFAULT: 100
+     *
+     * @param id the notification id
+     */
     public NotificationLoggingSetup withNotificationId(int id)
     {
         mNotificationId = id;
         return this;
     }
 
+    /**
+     * define a custom base id for the intents that will be broadcasted via the notification button clicks
+     * This number and the following 9 numbers will be used by the notification for handling the button clicks!
+     * DEFAULT: 100
+     *
+     * @param requestCodeBase the first request code for the notifications buttons
+     */
     public NotificationLoggingSetup withButtonIntentRequestCodeBase(int requestCodeBase)
     {
         mButtonIntentRequestCodeBase = requestCodeBase;
         return this;
     }
 
+    /**
+     * define a custom priority for the notification
+     * DEFAULT: {@link Notification#PRIORITY_MAX}
+     *
+     * @param priority the notifications priority
+     */
     public NotificationLoggingSetup withPriority(int priority)
     {
         mPriority = priority;
         return this;
     }
 
+    /**
+     * hand on all log groups you want this logger be able to skip through
+     * DEFAULT: NONE, because the groups are defined by you
+     *
+     * @param filters a list of all your log groups
+     */
     public NotificationLoggingSetup withFilters(ArrayList<ILogGroup> filters)
     {
         mFilters = filters;
         return this;
     }
 
-    public NotificationLoggingSetup withVibrateOn(int logLevel)
+    /**
+     * enable vibration whenever a log message is written to the notification
+     * DEFAULT: null (disabled)
+     *
+     * @param logLevel the minimum log level a log message must have to activate the vibration
+     */
+    public NotificationLoggingSetup withVibrateOn(Integer logLevel)
     {
         mVibrationLogLevel = logLevel;
         return this;
     }
 
-    public NotificationLoggingSetup withBeepOn(int logLevel)
+    /**
+     * enable a beep whenever a log message is written to the notification
+     * DEFAULT: null (disabled)
+     *
+     * @param logLevel the minimum log level a log message must have to activate the beep
+     */
+    public NotificationLoggingSetup withBeepOn(Integer logLevel)
     {
         mBeepLogLevel = logLevel;
         return this;
diff --git a/library-overlay/src/main/java/com/michaelflisar/lumberjack/OverlayLoggingSetup.java b/library-overlay/src/main/java/com/michaelflisar/lumberjack/OverlayLoggingSetup.java
index 2547e3b..0817f5b 100644
--- a/library-overlay/src/main/java/com/michaelflisar/lumberjack/OverlayLoggingSetup.java
+++ b/library-overlay/src/main/java/com/michaelflisar/lumberjack/OverlayLoggingSetup.java
@@ -26,60 +26,120 @@ public OverlayLoggingSetup()
 
     }
 
+    /**
+     * define a custom background for the overlay
+     * DEFAULT: #64000000 (light transparent grey)
+     *
+     * @param backgroundColor The background color
+     */
     public OverlayLoggingSetup withBackgroundColor(int backgroundColor)
     {
         mBackgroundColor = backgroundColor;
         return this;
     }
 
-    public OverlayLoggingSetup withColorVerbose(int colorVerbose)
+    /**
+     * define a custom message color for verbose logs
+     * DEFAULT: white
+     *
+     * @param color The color
+     */
+    public OverlayLoggingSetup withColorVerbose(int color)
     {
-        mColorVerbose = colorVerbose;
+        mColorVerbose = color;
         return this;
     }
 
-    public OverlayLoggingSetup withColorDebug(int colorDebug)
+    /**
+     * define a custom message color for debug logs
+     * DEFAULT: white
+     *
+     * @param color The color
+     */
+    public OverlayLoggingSetup withColorDebug(int color)
     {
-        mColorDebug = colorDebug;
+        mColorDebug = color;
         return this;
     }
 
-    public OverlayLoggingSetup withColorInfo(int colorInfo)
+    /**
+     * define a custom message color for info logs
+     * DEFAULT: white
+     *
+     * @param color The color
+     */
+    public OverlayLoggingSetup withColorInfo(int color)
     {
-        mColorInfo = colorInfo;
+        mColorInfo = color;
         return this;
     }
 
-    public OverlayLoggingSetup withColorWarn(int colorWarn)
+    /**
+     * define a custom message color for warn logs
+     * DEFAULT: white
+     *
+     * @param color The color
+     */
+    public OverlayLoggingSetup withColorWarn(int color)
     {
-        mColorWarn = colorWarn;
+        mColorWarn = color;
         return this;
     }
 
-    public OverlayLoggingSetup withColorError(int colorError)
+    /**
+     * define a custom message color for error logs
+     * DEFAULT: red
+     *
+     * @param color The color
+     */
+    public OverlayLoggingSetup withColorError(int color)
     {
-        mColorError = colorError;
+        mColorError = color;
         return this;
     }
 
-    public OverlayLoggingSetup withColorAssert(int colorAssert)
+    /**
+     * define a custom message color for assert logs
+     * DEFAULT: red
+     *
+     * @param color The color
+     */
+    public OverlayLoggingSetup withColorAssert(int color)
     {
-        mColorAssert = colorAssert;
+        mColorAssert = color;
         return this;
     }
 
+    /**
+     * define a custom request code for the permission request dialog
+     * DEFAULT: 200
+     *
+     * @param requestCode The request code
+     */
     public OverlayLoggingSetup withPermissionRequestCode(int requestCode)
     {
         mPermissionRequestCode = requestCode;
         return this;
     }
 
+    /**
+     * define a custom text size for log messages
+     * DEFAULT: 12dp
+     *
+     * @param dp The text size in dp
+     */
     public OverlayLoggingSetup withTextSizeInDp(int dp)
     {
         mTextSizeInDp = dp;
         return this;
     }
 
+    /**
+     * define a custom height for the overlay
+     * DEFAULT: 150dp
+     *
+     * @param dp The ovverlay height in dp
+     */
     public OverlayLoggingSetup withOverlayHeightInDp(int dp)
     {
         mOverlayHeightInDp = dp;
diff --git a/library-overlay/src/main/res/layout/overlay.xml b/library-overlay/src/main/res/layout/overlay.xml
index 734bfb6..55de2a0 100644
--- a/library-overlay/src/main/res/layout/overlay.xml
+++ b/library-overlay/src/main/res/layout/overlay.xml
@@ -22,10 +22,10 @@
 
    <TextView
        android:id="@+id/tvLabel"
-       android:layout_toLeftOf="@+id/llButtoons"
+       android:padding="4dp"
        android:layout_alignBottom="@+id/llButtoons"
        android:gravity="left|center_vertical"
-       android:layout_width="match_parent"
+       android:layout_width="wrap_content"
        android:layout_height="wrap_content"/>
 
     <android.support.v7.widget.RecyclerView