From f6ed7c0e2cee57503de2c2582dd29536e6cfdf0a Mon Sep 17 00:00:00 2001
From: Samuel Tardieu <sam@rfc1149.net>
Date: Thu, 23 May 2013 21:20:04 +0200
Subject: doc: enhance containsHtml() description

---
 main/src/cgeo/geocaching/utils/BaseUtils.java | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'main/src')

diff --git a/main/src/cgeo/geocaching/utils/BaseUtils.java b/main/src/cgeo/geocaching/utils/BaseUtils.java
index 82e48cb..b8006ad 100644
--- a/main/src/cgeo/geocaching/utils/BaseUtils.java
+++ b/main/src/cgeo/geocaching/utils/BaseUtils.java
@@ -137,10 +137,11 @@ public final class BaseUtils {
     }
 
     /**
-     * Quick and naive check for possible html-content of a string.
+     * Quick and naive check for possible rich HTML content in a string.
      *
-     * @param str
-     * @return True, if <code>str</code> could contain html
+     * @param str A string containing HTML code.
+     * @return <tt>true</tt> if <tt>str</tt> contains HTML code that needs to go through a HTML renderer before
+     *         being displayed, <tt>false</tt> if it can be displayed as-is without any loss
      */
     public static boolean containsHtml(final String str) {
         return str.indexOf('<') != -1 || str.indexOf('&') != -1;
-- 
cgit v1.1