[pydocs] fix missing function descriptions on export
authorMartijn Kaijser <mcm.kaijser@gmail.com>
Wed, 2 Oct 2013 18:33:09 +0000 (20:33 +0200)
committerMartijn Kaijser <mcm.kaijser@gmail.com>
Wed, 2 Oct 2013 18:33:09 +0000 (20:33 +0200)
xbmc/interfaces/legacy/PlayList.h
xbmc/interfaces/legacy/Player.h
xbmc/interfaces/legacy/Window.h

index 734b0eb..fe541de 100644 (file)
@@ -42,6 +42,9 @@ namespace XBMCAddon
       PlayList(int playList) throw (PlayListException);
       virtual ~PlayList();
 
+      /**
+       * getPlayListId() -- returns an integer.
+       */
       inline int getPlayListId() const { return iPlayList; }
 
       /**
index 41aa949..3f2a561 100644 (file)
@@ -42,13 +42,7 @@ namespace XBMCAddon
     /**
      * Player class.
      * 
-     * Player([core]) -- Creates a new Player with as default the xbmc music playlist.
-     * 
-     * core     : (optional) Use a specified playcore instead of letting xbmc decide the playercore to use.
-     *          - xbmc.PLAYER_CORE_AUTO
-     *          - xbmc.PLAYER_CORE_DVDPLAYER
-     *          - xbmc.PLAYER_CORE_MPLAYER
-     *          - xbmc.PLAYER_CORE_PAPLAYER
+     * Player() -- Creates a new Player class.
      */
 
     // This class is a merge of what was previously in xbmcmodule/player.h
@@ -63,11 +57,9 @@ namespace XBMCAddon
       EPLAYERCORES playerCore;
 
     public:
-      /**
-       * Construct a Player proxying the given generated binding. The 
-       *  construction of a Player needs to identify whether or not any 
-       *  callbacks will be executed asynchronously or not.
-       */
+      // Construct a Player proxying the given generated binding. The 
+      //  construction of a Player needs to identify whether or not any 
+      //  callbacks will be executed asynchronously or not.
       Player(int playerCore = EPC_NONE);
       virtual ~Player(void);
 
@@ -87,7 +79,7 @@ namespace XBMCAddon
        * example:
        *   - listitem = xbmcgui.ListItem('Ironman')
        *   - listitem.setInfo('video', {'Title': 'Ironman', 'Genre': 'Science Fiction'})
-       *   - xbmc.Player( xbmc.PLAYER_CORE_MPLAYER ).play(url, listitem, windowed)
+       *   - xbmc.Player().play(url, listitem, windowed)
        */
       void playStream(const String& item = emptyString, const XBMCAddon::xbmcgui::ListItem* listitem = NULL, bool windowed = false);
 
@@ -111,11 +103,12 @@ namespace XBMCAddon
 
       /**
        * play() -- try to play the current item in the current playlist.
-       *
-       * windowed       : [opt] bool - true=play video windowed, false=play users preference.(default)
+       * 
+       * windowed       : [opt] bool - true=play video windowed, false=play users preference (default).
        * 
        * example:
-       *   - xbmc.Player( xbmc.PLAYER_CORE_MPLAYER ).play()
+       * 
+       *   - xbmc.Player().play()
        */
       void playCurrent(bool windowed = false);
 
@@ -335,14 +328,19 @@ namespace XBMCAddon
        */
       double getTotalTime() throw (PlayerException);
 
+      // Player_getAvailableAudioStreams
+      /**
+       * getAvailableAudioStreams() -- get Audio stream names
+       */
       std::vector<String>* getAvailableAudioStreams();
 
       /**
-       * setAudioStream(stream) -- set Audio Stream 
-       *
+       * setAudioStream(stream) -- set Audio Stream.
+       * 
        * stream           : int
-       *
+       * 
        * example:
+       * 
        *    - setAudioStream(1)
        */
       void setAudioStream(int iStream);
index 1777bd2..636db05 100644 (file)
@@ -63,9 +63,24 @@ namespace XBMCAddon
       AddonClass::Ref<Control> control; // previously pObject
 #endif
 
+    /**
+     * getId() -- Returns the action's current id as a long or 0 if no action is mapped in the xml's.
+     */
       long getId() { TRACE; return id; }
+
+    /**
+     * getButtonCode() -- Returns the button code for this action.
+     */
       long getButtonCode() { TRACE; return buttonCode; }
+
+    /**
+     * getAmount1() -- Returns the first amount of force applied to the thumbstick n.
+     */
       float getAmount1() { TRACE; return fAmount1; }
+      
+    /**
+     * getAmount2() -- Returns the second amount of force applied to the thumbstick n.
+     */
       float getAmount2() { TRACE; return fAmount2; }
     };