Skip to content

Commit

Permalink
[pydocs] addon id is optional for the Addon() class as it's retrieved…
Browse files Browse the repository at this point in the history
… automaticly. Also "id=" in front of the int isn't needed to retrieve language string.
  • Loading branch information
MartijnKaijser committed Sep 16, 2013
1 parent 36bb1f4 commit 28eaa40
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions xbmc/interfaces/legacy/Addon.h
Expand Up @@ -36,14 +36,17 @@ namespace XBMCAddon
/**
* Addon class.
*
* Addon(id) -- Creates a new Addon class.
* Addon([id]) -- Creates a new Addon class.
*
* id : string - id of the addon.
* id : [opt] string - id of the addon as specified in addon.xml
*
* *Note, You can use the above as a keyword.
* *Note, specifying the addon id is not needed.\n
* Important however is that the addon folder has the same name as the addon id provided in addon.xml.\n
* You can optionally specify the addon id from another installed addon to retrieve settings from it.
*
* example:
* - self.Addon = xbmcaddon.Addon(id='script.recentlyadded')
* - self.Addon = xbmcaddon.Addon()
* - self.Addon = xbmcaddon.Addon('script.foo.bar')
*/
class Addon : public AddonClass
{
Expand All @@ -57,12 +60,17 @@ namespace XBMCAddon
/**
* Addon class.
*
* Addon(id) -- Creates a new Addon class.
* Addon([id]) -- Creates a new Addon class.
*
* id : string - id of the addon.
* id : [opt] string - id of the addon as specified in addon.xml\n
*
* *Note, specifying the addon id is not needed.\n
* Important however is that the addon folder has the same name as the addon id provided in addon.xml.\n
* You can optionally specify the addon id from another installed addon to retrieve settings from it.
*
* example:
* - self.Addon = xbmcaddon.Addon(id='script.recentlyadded')
* - self.Addon = xbmcaddon.Addon()
* - self.Addon = xbmcaddon.Addon('script.foo.bar')
*/
Addon(const char* id = NULL) throw (AddonException);

Expand All @@ -71,10 +79,10 @@ namespace XBMCAddon
/**
* getLocalizedString(id) -- Returns an addon's localized 'unicode string'.
*
* id : integer - id# for string you want to localize.
* id : integer - id# for string you want to localize.
*
* example:
* - locstr = self.Addon.getLocalizedString(id=6)
* - locstr = self.Addon.getLocalizedString(32000)
*/
String getLocalizedString(int id);

Expand Down

0 comments on commit 28eaa40

Please sign in to comment.