improve documentation

willforde · Mar 10, 2018 · aff2774 · aff2774
1 parent e16c240
commit aff2774
Show file tree

Hide file tree

Showing 14 changed files with 265 additions and 191 deletions.
diff --git a/docs/api/listitem.rst b/docs/api/listitem.rst
@@ -4,6 +4,25 @@ The list item control is used for creating item lists in Kodi.
 
 .. autoclass:: codequick.listing.Listitem
     :members:
+    :exclude-members: info, art, stream, context, params, property
+
+    .. autoinstanceattribute:: art
+        :annotation: = listing.art()
+
+    .. autoinstanceattribute:: info
+        :annotation: = listing.Info()
+
+    .. autoinstanceattribute:: stream
+        :annotation: = listing.stream()
+
+    .. autoinstanceattribute:: context
+        :annotation: = listing.context()
+
+    .. autoinstanceattribute:: property
+        :annotation: = dict()
+
+    .. autoinstanceattribute:: params
+        :annotation: = dict()
 
 .. autoclass:: codequick.listing.Art
     :members:

diff --git a/docs/api/resolver.rst b/docs/api/resolver.rst
@@ -1,5 +1,8 @@
 Resolver
 ========
+This module is used to create Resolver callbacks. Resolver callbacks, are callbacks that
+return playable video urls witch kodi can play.
 
 .. autoclass:: codequick.resolver.Resolver
    :members:
+   :exclude-members: create_loopback
diff --git a/docs/api/route.rst b/docs/api/route.rst
@@ -1,23 +1,28 @@
 Route
 =====
+This module is used to create Route callbacks. Route callbacks, are callbacks that
+return listitems witch show up as folders in kodi.
 
 .. autoclass:: codequick.route.Route
     :members: add_sort_methods
 
     .. attribute:: autosort
         :annotation: = True
 
-        Set to ``False`` to disable autosort.
+        Set to ``False`` to disable auto sortmethod selection.
 
     .. attribute:: update_listing
         :annotation: = False
 
-        When set to ``True`` the current lsting will be updated
+        When set to ``True``, the current page of listitems will be updated instead of creating a new page of listitems.
 
     .. attribute:: content_type
         :annotation: = None
 
-        The add-on's content type. If not given it will default to files/videos, based on type of content.
+        The add-on's content type.
+
+        If not given then the content type is based on the mediatype infolabel of the listitems.
+        If the mediatype infolabel was not set then it defaults to files/videos, based on type of content.
 
         * 'files' when listing folders.
         * 'videos' when listing videos.

diff --git a/docs/api/script.rst b/docs/api/script.rst
@@ -1,9 +1,15 @@
 Script
 ======
+This module is used for creating script callbacks witch are also used as the base for all other types of callbacks.
 
 .. autoclass:: codequick.script.Script
     :members:
 
 .. autoclass:: codequick.script.Settings
-    :members:
-    :special-members: __getitem__, __setitem__
+
+    .. automethod:: __getitem__
+    .. automethod:: __setitem__
+    .. automethod:: get_string(key, addon_id=None)
+    .. automethod:: get_boolean(key, addon_id=None)
+    .. automethod:: get_int(key, addon_id=None)
+    .. automethod:: get_number(key, addon_id=None)