Merge pull request #7749 from MartijnKaijser/pydoc

Pydoc

7 files changed, 74 insertions, 30 deletions

diff --git a/xbmc/interfaces/legacy/Control.h b/xbmc/interfaces/legacy/Control.h
index cadfb78bb3..10430eb5f2 100644
--- a/xbmc/interfaces/legacy/Control.h
+++ b/xbmc/interfaces/legacy/Control.h
@@ -126,7 +126,7 @@ namespace XBMCAddon
       // setVisibleCondition() Method
       /**
        * setVisibleCondition(visible[,allowHiddenFocus]) -- Set's the control's visible condition.
-       *     Allows XBMC to control the visible status of the control.
+       *     Allows Kodi to control the visible status of the control.
        * 
        * visible          : string - Visible condition.\n
        * allowHiddenFocus : bool - True=gains focus even if hidden.
@@ -141,7 +141,7 @@ namespace XBMCAddon
       // setEnableCondition() Method
       /**
        * setEnableCondition(enable) -- Set's the control's enabled condition.
-       *     Allows XBMC to control the enabled status of the control.
+       *     Allows Kodi to control the enabled status of the control.
        * 
        * enable           : string - Enable condition.
        * 
diff --git a/xbmc/interfaces/legacy/Dialog.h b/xbmc/interfaces/legacy/Dialog.h
index 5cc7c3ee1a..9fc9694273 100644
--- a/xbmc/interfaces/legacy/Dialog.h
+++ b/xbmc/interfaces/legacy/Dialog.h
@@ -56,7 +56,7 @@ namespace XBMCAddon
        * yesno(heading, line1[, line2, line3]) -- Show a dialog 'YES/NO'.\n
        * \n
        * heading        : string or unicode - dialog heading.\n
-       * line1          : string or unicode - line #1 text.\n
+       * line1          : string or unicode - line #1 multi-line text.\n
        * line2          : [opt] string or unicode - line #2 text.\n
        * line3          : [opt] string or unicode - line #3 text.\n
        * nolabel        : [opt] label to put on the no button.\n
@@ -64,11 +64,11 @@ namespace XBMCAddon
        * autoclose      : [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)\n
        * \n
        * *Note, Returns True if 'Yes' was pressed, else False.\n
-       * *Note, Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.\n
+       * *Note, it is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.\n
        * \n
        * example:\n
        *   - dialog = xbmcgui.Dialog()\n
-       *   - ret = dialog.yesno('XBMC', 'Do you want to exit this script?')n\n
+       *   - ret = dialog.yesno('Kodi', 'Do you want to exit this script?')n\n
        */
       bool yesno(const String& heading, const String& line1, 
                  const String& line2 = emptyString,
@@ -96,12 +96,12 @@ namespace XBMCAddon
        * ok(heading, line1[, line2, line3]) -- Show a dialog 'OK'.\n
        * \n
        * heading        : string or unicode - dialog heading.\n
-       * line1          : string or unicode - line #1 text.\n
+       * line1          : string or unicode - line #1 multi-line text.\n
        * line2          : [opt] string or unicode - line #2 text.\n
        * line3          : [opt] string or unicode - line #3 text.\n
        * \n
        * *Note, Returns True if 'Ok' was pressed, else False.\n
-       * *Note: Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.\n
+       * *Note, it is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.\n
        * \n
        * example:\n
        *   - dialog = xbmcgui.Dialog()\n
@@ -306,11 +306,11 @@ namespace XBMCAddon
        * create(heading[, line1, line2, line3]) -- Create and show a progress dialog.\n
        * \n
        * heading        : string or unicode - dialog heading.\n
-       * line1          : [opt] string or unicode - line #1 text.\n
+       * line1          : [opt] string or unicode - line #1 multi-line text.\n
        * line2          : [opt] string or unicode - line #2 text.\n
        * line3          : [opt] string or unicode - line #3 text.\n
        * \n
-       * *Note, Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.\n
+       * *Note, it is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.\n
        * *Note, Use update() to update lines and progressbar.\n
        * \n
        * example:
@@ -325,11 +325,11 @@ namespace XBMCAddon
        * update(percent[, line1, line2, line3]) -- Updates the progress dialog.\n
        * \n
        * percent        : integer - percent complete. (0:100)\n
-       * line1          : [opt] string or unicode - line #1 text.\n
+       * line1          : [opt] string or unicode - line #1 multi-line text.\n
        * line2          : [opt] string or unicode - line #2 text.\n
        * line3          : [opt] string or unicode - line #3 text.\n
        * \n
-       * *Note, Optionally line1 can be sent as multi-line text. In this case line2 and line3 must be omitted.\n
+       * *Note, it is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.\n
        * *Note, If percent == 0, the progressbar will be hidden.\n
        * \n
        * example:
diff --git a/xbmc/interfaces/legacy/ListItem.h b/xbmc/interfaces/legacy/ListItem.h
index 9178bb99cc..c841068f07 100644
--- a/xbmc/interfaces/legacy/ListItem.h
+++ b/xbmc/interfaces/legacy/ListItem.h
@@ -340,7 +340,7 @@ namespace XBMCAddon
        * \n
        * mimetype           : string or unicode - mimetype.\n
        * \n
-       * *If known prehand, this can avoid xbmc doing HEAD requests to http servers to figure out file type.\n
+       * *If known prehand, this can avoid Kodi doing HEAD requests to http servers to figure out file type.\n
        */
       void setMimeType(const String& mimetype);
 
diff --git a/xbmc/interfaces/legacy/ModuleXbmc.h b/xbmc/interfaces/legacy/ModuleXbmc.h
index cde3dd49b3..9817525b5d 100644
--- a/xbmc/interfaces/legacy/ModuleXbmc.h
+++ b/xbmc/interfaces/legacy/ModuleXbmc.h
@@ -44,9 +44,9 @@ namespace XBMCAddon
      *        Once you use a keyword, all following arguments require the keyword.\n
      * \n
      * Text is written to the log for the following conditions.\n
-     *           XBMC loglevel == -1 (NONE, nothing at all is logged)\n
-     *           XBMC loglevel == 0 (NORMAL, shows LOGNOTICE, LOGERROR, LOGSEVERE and LOGFATAL)\n
-     *           XBMC loglevel == 1 (DEBUG, shows all)\n
+     *           - loglevel == -1 (NONE, nothing at all is logged)
+     *           - loglevel == 0 (NORMAL, shows LOGNOTICE, LOGERROR, LOGSEVERE and LOGFATAL)
+     *           - loglevel == 1 (DEBUG, shows all)
      *           See pydocs for valid values for level.\n
      *           
      *           example:
@@ -80,7 +80,7 @@ namespace XBMCAddon
     void executescript(const char* script);
 
     /**
-     * executebuiltin(function) -- Execute a built in XBMC function.
+     * executebuiltin(function) -- Execute a built in Kodi function.
      * 
      * function       : string - builtin function to execute.
      * 
diff --git a/xbmc/interfaces/legacy/ModuleXbmcplugin.h b/xbmc/interfaces/legacy/ModuleXbmcplugin.h
index f89e2205ab..a400cb6bd4 100644
--- a/xbmc/interfaces/legacy/ModuleXbmcplugin.h
+++ b/xbmc/interfaces/legacy/ModuleXbmcplugin.h
@@ -47,7 +47,7 @@ namespace XBMCAddon
                           bool isFolder = false, int totalItems = 0);
 
     /**
-     * addDirectoryItems(handle, items [,totalItems]) -- Callback function to pass directory contents back to XBMC as a list.
+     * addDirectoryItems(handle, items [,totalItems]) -- Callback function to pass directory contents back to Kodi as a list.
      *  - Returns a bool for successful completion.
      * 
      * handle      : integer - handle the plugin was started with.\n
@@ -65,7 +65,7 @@ namespace XBMCAddon
                            int totalItems = 0);
 
     /**
-     * endOfDirectory(handle[, succeeded, updateListing, cacheToDisc]) -- Callback function to tell XBMC that the end of the directory listing in a virtualPythonFolder module is reached.
+     * endOfDirectory(handle[, succeeded, updateListing, cacheToDisc]) -- Callback function to tell Kodi that the end of the directory listing in a virtualPythonFolder module is reached.
      * 
      * handle           : integer - handle the plugin was started with.\n
      * succeeded        : [opt] bool - True=script completed successfully(Default)/False=Script did not.\n
@@ -79,7 +79,7 @@ namespace XBMCAddon
                         bool cacheToDisc = true);
 
     /**
-     * setResolvedUrl(handle, succeeded, listitem) -- Callback function to tell XBMC that the file plugin has been resolved to a url
+     * setResolvedUrl(handle, succeeded, listitem) -- Callback function to tell Kodi that the file plugin has been resolved to a url
      * 
      * handle           : integer - handle the plugin was started with.\n
      * succeeded        : bool - True=script completed successfully/False=Script did not.\n
@@ -91,10 +91,10 @@ namespace XBMCAddon
     void setResolvedUrl(int handle, bool succeeded, const XBMCAddon::xbmcgui::ListItem* listitem);
 
     /**
-     * addSortMethod(handle, sortMethod, label2Mask) -- Adds a sorting method for the media list.
+     * addSortMethod(handle, sortMethod [,label2Mask]) -- Adds a sorting method for the media list.
      * 
      * handle      : integer - handle the plugin was started with.\n
-     * sortMethod  : integer - number for sortmethod see SortFileItem.h.\n
+     * sortMethod  : integer - see available sort methods below (or see SortFileItem.h).\n
      * label2Mask  : [opt] string - the label mask to use for the second label.  Defaults to '%D'
      *               - applies to:
      *                           - SORT_METHOD_NONE, SORT_METHOD_UNSORTED, SORT_METHOD_VIDEO_TITLE,
@@ -103,9 +103,53 @@ namespace XBMCAddon
      *                           - SORT_METHOD_LABEL_IGNORE_THE, SORT_METHOD_VIDEO_SORT_TITLE,
      *                           - SORT_METHOD_VIDEO_SORT_TITLE_IGNORE_THE, SORT_METHOD_FULLPATH,
      *                           - SORT_METHOD_LABEL_IGNORE_FOLDERS, SORT_METHOD_CHANNEL
-     * 
+     *   - sortMethods available:
+     *        - xbmcplugin.SORTMETHOD_NONE
+     *        - xbmcplugin.SORTMETHOD_LABEL
+     *        - xbmcplugin.SORTMETHOD_LABEL_IGNORE_THE
+     *        - xbmcplugin.SORTMETHOD_DATE
+     *        - xbmcplugin.SORTMETHOD_SIZE
+     *        - xbmcplugin.SORTMETHOD_FILE
+     *        - xbmcplugin.SORTMETHOD_DRIVE_TYPE
+     *        - xbmcplugin.SORTMETHOD_TRACKNUM
+     *        - xbmcplugin.SORTMETHOD_DURATION
+     *        - xbmcplugin.SORTMETHOD_TITLE
+     *        - xbmcplugin.SORTMETHOD_TITLE_IGNORE_THE
+     *        - xbmcplugin.SORTMETHOD_ARTIST
+     *        - xbmcplugin.SORTMETHOD_ARTIST_IGNORE_THE
+     *        - xbmcplugin.SORTMETHOD_ALBUM
+     *        - xbmcplugin.SORTMETHOD_ALBUM_IGNORE_THE
+     *        - xbmcplugin.SORTMETHOD_GENRE
+     *        - xbmcplugin.SORTMETHOD_COUNTRY
+     *        - xbmcplugin.SORTMETHOD_YEAR
+     *        - xbmcplugin.SORTMETHOD_VIDEO_RATING
+     *        - xbmcplugin.SORTMETHOD_DATEADDED
+     *        - xbmcplugin.SORTMETHOD_PROGRAM_COUNT
+     *        - xbmcplugin.SORTMETHOD_PLAYLIST_ORDER
+     *        - xbmcplugin.SORTMETHOD_EPISODE
+     *        - xbmcplugin.SORTMETHOD_VIDEO_TITLE
+     *        - xbmcplugin.SORTMETHOD_VIDEO_SORTTITLE
+     *        - xbmcplugin.SORTMETHOD_VIDEO_SORTTITLE_IGNORE_THE
+     *        - xbmcplugin.SORTMETHOD_PRODUCTIONCODE
+     *        - xbmcplugin.SORTMETHOD_SONG_RATING
+     *        - xbmcplugin.SORTMETHOD_MPAA_RATING
+     *        - xbmcplugin.SORTMETHOD_VIDEO_RUNTIME
+     *        - xbmcplugin.SORTMETHOD_STUDIO
+     *        - xbmcplugin.SORTMETHOD_STUDIO_IGNORE_THE
+     *        - xbmcplugin.SORTMETHOD_FULLPATH
+     *        - xbmcplugin.SORTMETHOD_LABEL_IGNORE_FOLDERS
+     *        - xbmcplugin.SORTMETHOD_LASTPLAYED
+     *        - xbmcplugin.SORTMETHOD_PLAYCOUNT
+     *        - xbmcplugin.SORTMETHOD_LISTENERS
+     *        - xbmcplugin.SORTMETHOD_UNSORTED
+     *        - xbmcplugin.SORTMETHOD_CHANNEL
+     *        - xbmcplugin.SORTMETHOD_CHANNEL_NUMBER
+     *        - xbmcplugin.SORTMETHOD_BITRATE
+     *        - xbmcplugin.SORTMETHOD_DATE_TAKEN
+     *  *Note: to add multiple sort methods just call the method multiple times.
+     *
      * example:
-     *   - xbmcplugin.addSortMethod(int(sys.argv[1]), 1)
+     *   - xbmcplugin.addSortMethod(int(sys.argv[1]), xbmcplugin.SORTMETHOD_DATEADDED)
      */
     void addSortMethod(int handle, int sortMethod, const String& label2Mask = emptyString);
 
diff --git a/xbmc/interfaces/legacy/Monitor.h b/xbmc/interfaces/legacy/Monitor.h
index fa94c494ca..7312fbd91c 100644
--- a/xbmc/interfaces/legacy/Monitor.h
+++ b/xbmc/interfaces/legacy/Monitor.h
@@ -159,7 +159,7 @@ namespace XBMCAddon
        * method : name of the notification\n
        * data   : JSON-encoded data of the notification\n
        *\n
-       * Will be called when XBMC receives or sends a notification\n
+       * Will be called when Kodi receives or sends a notification\n
        */
       virtual void    onNotification(const String sender, const String method, const String data) { XBMC_TRACE; }
 
diff --git a/xbmc/interfaces/legacy/Player.h b/xbmc/interfaces/legacy/Player.h
index 1908f51acf..551d7e395c 100644
--- a/xbmc/interfaces/legacy/Player.h
+++ b/xbmc/interfaces/legacy/Player.h
@@ -124,7 +124,7 @@ namespace XBMCAddon
       /**
        * onPlayBackStarted() -- onPlayBackStarted method.
        * 
-       * Will be called when xbmc starts playing a file
+       * Will be called when Kodi starts playing a file
        */
       // Player_OnPlayBackStarted
       virtual void onPlayBackStarted();
@@ -133,7 +133,7 @@ namespace XBMCAddon
       /**
        * onPlayBackEnded() -- onPlayBackEnded method.
        * 
-       * Will be called when xbmc stops playing a file
+       * Will be called when Kodi stops playing a file
        */
       // Player_OnPlayBackEnded
       virtual void onPlayBackEnded();
@@ -141,7 +141,7 @@ namespace XBMCAddon
       /**
        * onPlayBackStopped() -- onPlayBackStopped method.
        * 
-       * Will be called when user stops xbmc playing a file
+       * Will be called when user stops Kodi playing a file
        */
       // Player_OnPlayBackStopped
       virtual void onPlayBackStopped();
@@ -200,19 +200,19 @@ namespace XBMCAddon
       virtual void onPlayBackSeekChapter(int chapter);
 
       /**
-       * isPlaying() -- returns True is xbmc is playing a file.
+       * isPlaying() -- returns True is Kodi is playing a file.
        */
       // Player_IsPlaying
       bool isPlaying();
 
       /**
-       * isPlayingAudio() -- returns True is xbmc is playing an audio file.
+       * isPlayingAudio() -- returns True is Kodi is playing an audio file.
        */
       // Player_IsPlayingAudio
       bool isPlayingAudio();
 
       /**
-       * isPlayingVideo() -- returns True if xbmc is playing a video.
+       * isPlayingVideo() -- returns True if Kodi is playing a video.
        */
       // Player_IsPlayingVideo
       bool isPlayingVideo();