diff src/browser/sat_browser/menu.py @ 690:76a67d04c63e

browser_side: improve comments for menus-related methods
author souliane <souliane@mailoo.org>
date Thu, 09 Apr 2015 11:40:53 +0200
parents 90a5a5af2550
children f1271f769ffd
line wrap: on
line diff
--- a/src/browser/sat_browser/menu.py	Thu Apr 02 00:36:08 2015 +0200
+++ b/src/browser/sat_browser/menu.py	Thu Apr 09 11:40:53 2015 +0200
@@ -48,6 +48,11 @@
 
     @classmethod
     def getCategoryHTML(cls, category):
+        """Build the html to be used for displaying a category item.
+
+        @param category (quick_menus.MenuCategory): category to add
+        @return unicode: HTML to display
+        """
         name = html_tools.html_sanitize(category.name)
         return cls.ITEM_TPL % (category.icon, name) if category.icon is not None else name