Skip to content
This repository
Browse code

[pydocs] addon id is optional for the Addon() class as it's retrieved…

… automaticly. Also "id=" in front of the int isn't needed to retrieve language string.
  • Loading branch information...
commit 28eaa400104db07dd5c173d1852e01193c314492 1 parent 36bb1f4
Martijn Kaijser authored September 16, 2013

Showing 1 changed file with 17 additions and 9 deletions. Show diff stats Hide diff stats

  1. 26  xbmc/interfaces/legacy/Addon.h
26  xbmc/interfaces/legacy/Addon.h
@@ -36,14 +36,17 @@ namespace XBMCAddon
36 36
     /**
37 37
      * Addon class.
38 38
      * 
39  
-     * Addon(id) -- Creates a new Addon class.
  39
+     * Addon([id]) -- Creates a new Addon class.
40 40
      * 
41  
-     * id          : string - id of the addon.
  41
+     * id          : [opt] string - id of the addon as specified in addon.xml
42 42
      * 
43  
-     * *Note, You can use the above as a keyword.
  43
+     * *Note, specifying the addon id is not needed.\n
  44
+     *  Important however is that the addon folder has the same name as the addon id provided in addon.xml.\n
  45
+     *  You can optionally specify the addon id from another installed addon to retrieve settings from it.
44 46
      * 
45 47
      * example:
46  
-     *  - self.Addon = xbmcaddon.Addon(id='script.recentlyadded')
  48
+     *  - self.Addon = xbmcaddon.Addon()
  49
+     *  - self.Addon = xbmcaddon.Addon('script.foo.bar')
47 50
      */
48 51
     class Addon : public AddonClass
49 52
     {
@@ -57,12 +60,17 @@ namespace XBMCAddon
57 60
       /**
58 61
        * Addon class.
59 62
        * 
60  
-       * Addon(id) -- Creates a new Addon class.
  63
+       * Addon([id]) -- Creates a new Addon class.
61 64
        * 
62  
-       * id          : string - id of the addon.
  65
+       * id          : [opt] string - id of the addon as specified in addon.xml\n
  66
+       * 
  67
+       * *Note, specifying the addon id is not needed.\n
  68
+       *  Important however is that the addon folder has the same name as the addon id provided in addon.xml.\n
  69
+       *  You can optionally specify the addon id from another installed addon to retrieve settings from it.
63 70
        * 
64 71
        * example:
65  
-       *  - self.Addon = xbmcaddon.Addon(id='script.recentlyadded')
  72
+       *  - self.Addon = xbmcaddon.Addon()
  73
+       *  - self.Addon = xbmcaddon.Addon('script.foo.bar')
66 74
        */
67 75
       Addon(const char* id = NULL) throw (AddonException);
68 76
 
@@ -71,10 +79,10 @@ namespace XBMCAddon
71 79
       /**
72 80
        * getLocalizedString(id) -- Returns an addon's localized 'unicode string'.
73 81
        * 
74  
-       * id             : integer - id# for string you want to localize.
  82
+       * id        : integer - id# for string you want to localize.
75 83
        * 
76 84
        * example:
77  
-       *   - locstr = self.Addon.getLocalizedString(id=6)
  85
+       *   - locstr = self.Addon.getLocalizedString(32000)
78 86
        */
79 87
       String getLocalizedString(int id);
80 88
 

0 notes on commit 28eaa40

Please sign in to comment.
Something went wrong with that request. Please try again.