From fb5a260f4b4879503bd5385f96a97612b0e49d13 Mon Sep 17 00:00:00 2001
From: Brendan Jackman <brendan.jackman@arm.com>
Date: Thu, 21 Sep 2017 13:20:46 +0100
Subject: [PATCH] utils/anroid: Documentation for LogcatMonitor

---
 devlib/utils/android.py | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/devlib/utils/android.py b/devlib/utils/android.py
index 170fda0..1f1f762 100644
--- a/devlib/utils/android.py
+++ b/devlib/utils/android.py
@@ -533,6 +533,16 @@ def _check_env():
         aapt = _env.aapt
 
 class LogcatMonitor(threading.Thread):
+    """
+    Helper class for monitoring Anroid's logcat
+
+    :param target: Android target to monitor
+    :type target: :class:`AndroidTarget`
+
+                    device. Logcat entries that don't match any will not be
+                    seen. If omitted, all entries will be sent to host.
+    :type regexps: list(str)
+    """
 
     FLUSH_SIZE = 1000
 
@@ -556,6 +566,12 @@ class LogcatMonitor(threading.Thread):
         self._regexps = regexps
 
     def start(self, outfile=None):
+        """
+        Start logcat and begin monitoring
+
+        :param outfile: Optional path to file to store all logcat entries
+        :type outfile: str
+        """
         if outfile:
             self._logfile = outfile
         else:
@@ -653,6 +669,15 @@ class LogcatMonitor(threading.Thread):
         """
         Search a line that matches a regexp in the logcat log
         Wait for it to appear if it's not found
+
+        :param regexp: regexp to search
+        :type regexp: str
+
+        :param timeout: Timeout in seconds, before rasing RuntimeError.
+                        ``None`` means wait indefinitely
+        :type timeout: number
+
+        :returns: List of matched strings
         """
         res = self.search(regexp)