src/eric7/WebBrowser/Bookmarks/BookmarksImporters/XbelImporter.py

branch
eric7
changeset 10436
f6881d10e995
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/WebBrowser/Bookmarks/BookmarksImporters/XbelImporter.py	Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/Bookmarks/BookmarksImporters/XbelImporter.py	Fri Dec 22 17:24:07 2023 +0100
@@ -21,11 +21,12 @@
     """
     Module function to get information for the given XBEL source id.
 
-    @param sourceId id of the browser ("chrome" or "chromium")
-    @return tuple with an icon (QPixmap), readable name (string), name of
-        the default bookmarks file (string), an info text (string),
-        a prompt (string) and the default directory of the bookmarks file
-        (string)
+    @param sourceId id of the browser
+    @type str
+    @return tuple with an icon, readable name, name of the default
+        bookmarks file, an info text, a prompt and the default directory
+        of the bookmarks file
+    @rtype tuple of (QPixmap, str, str, str, str, str)
     @exception ValueError raised to indicate an invalid browser ID
     """
     if sourceId not in ("e5browser", "konqueror", "xbel"):
@@ -113,7 +114,8 @@
         """
         Public method to set the path of the bookmarks file or directory.
 
-        @param path bookmarks file or directory (string)
+        @param path bookmarks file or directory
+        @type str
         """
         self.__fileName = path
 
@@ -121,7 +123,8 @@
         """
         Public method to open the bookmarks file.
 
-        @return flag indicating success (boolean)
+        @return flag indicating success
+        @rtype bool
         """
         if not os.path.exists(self.__fileName):
             self._error = True
@@ -135,7 +138,8 @@
         """
         Public method to get the imported bookmarks.
 
-        @return imported bookmarks (BookmarkNode)
+        @return imported bookmarks
+        @rtype BookmarkNode
         """
         from ..BookmarkNode import BookmarkNode
         from ..XbelReader import XbelReader

eric ide

mercurial