diff options
author | Cory Fields <theuni-nospam-@xbmc.org> | 2012-12-01 18:58:21 -0500 |
---|---|---|
committer | Cory Fields <theuni-nospam-@xbmc.org> | 2012-12-01 18:59:02 -0500 |
commit | 928b58cf5019a87c5890019c2153a8acf811611a (patch) | |
tree | 4d33a7c35857fc12cc1ac939b0349211133e9f7d | |
parent | 85baee9d78b2404ef00fcb1b0b97367c2a1e82e3 (diff) |
Revert "[cosmetic] Fix the docstring generation formatting."
This reverts commit eafaeba9b806bfafd2b0693bb873691e08d333c3.
-rw-r--r-- | xbmc/interfaces/legacy/AddonClass.h | 2 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/AddonUtils.h | 2 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/Control.h | 148 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/Dialog.h | 26 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/File.h | 12 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/InfoTagVideo.h | 4 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/Keyboard.h | 14 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/ListItem.h | 38 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/ModuleXbmc.h | 62 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/ModuleXbmcgui.h | 8 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/ModuleXbmcplugin.h | 22 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/ModuleXbmcvfs.h | 16 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/Monitor.h | 12 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/PlayList.h | 18 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/Player.h | 70 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/RenderCapture.h | 16 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/Stat.h | 2 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/Window.h | 52 | ||||
-rw-r--r-- | xbmc/interfaces/legacy/WindowXML.h | 4 |
19 files changed, 2 insertions, 526 deletions
diff --git a/xbmc/interfaces/legacy/AddonClass.h b/xbmc/interfaces/legacy/AddonClass.h index d23e795f5c..d9e991c155 100644 --- a/xbmc/interfaces/legacy/AddonClass.h +++ b/xbmc/interfaces/legacy/AddonClass.h @@ -28,7 +28,7 @@ * * Comment out (or uncomment out) to change the setting. */ -#define LOG_LIFECYCLE_EVENTS +//#define LOG_LIFECYCLE_EVENTS /** * Defining XBMC_ADDON_DEBUG_MEMORY will make the Acquire and Release diff --git a/xbmc/interfaces/legacy/AddonUtils.h b/xbmc/interfaces/legacy/AddonUtils.h index 0e29bdd960..bb0e7470df 100644 --- a/xbmc/interfaces/legacy/AddonUtils.h +++ b/xbmc/interfaces/legacy/AddonUtils.h @@ -28,7 +28,7 @@ #pragma once -#define ENABLE_TRACE_API +//#define ENABLE_TRACE_API #include "threads/SingleLock.h" diff --git a/xbmc/interfaces/legacy/Control.h b/xbmc/interfaces/legacy/Control.h index 1f8a8ba9ae..a8854c086e 100644 --- a/xbmc/interfaces/legacy/Control.h +++ b/xbmc/interfaces/legacy/Control.h @@ -43,7 +43,6 @@ namespace XBMCAddon { /** - * <pre> * Parent for control classes. The problem here is that Python uses * references to this class in a dynamic typing way. For example, * you will find this type of python code frequently: @@ -74,7 +73,6 @@ namespace XBMCAddon * TODO:This later solution should be implemented for future scripting * languages while the former will remain as deprecated functionality * for Python. - * </pre> */ // We don't need the SWIGHIDDENVIRTUAL since this is not a director. class Control : public AddonClass @@ -141,12 +139,10 @@ namespace XBMCAddon virtual void addListItem(const XBMCAddon::xbmcgui::ListItem* listitem, bool sendMessage = true) DECL_UNIMP2("Control",WindowException); /** - * <pre> * getId() -- Returns the control's current id as an integer. * * example: * - id = self.button.getId()\n - * </pre> */ virtual int getId() { return iControlId; } @@ -156,67 +152,56 @@ namespace XBMCAddon // hack this because it returns a tuple /** - * <pre> * getPosition() -- Returns the control's current position as a x,y integer tuple. * * example: * - pos = self.button.getPosition() - * </pre> */ virtual std::vector<int> getPosition(); virtual int getX() { return dwPosX; } virtual int getY() { return dwPosY; } /** - * <pre> * getHeight() -- Returns the control's current height as an integer. * * example: * - height = self.button.getHeight() - * </pre> */ virtual int getHeight() { return dwHeight; } // getWidth() Method /** - * <pre> * getWidth() -- Returns the control's current width as an integer. * * example: * - width = self.button.getWidth() - * </pre> */ virtual int getWidth() { return dwWidth; } // setEnabled() Method /** - * <pre> * setEnabled(enabled) -- Set's the control's enabled/disabled state. * * enabled : bool - True=enabled / False=disabled. * * example: * - self.button.setEnabled(False)\n - * </pre> */ virtual void setEnabled(bool enabled); // setVisible() Method /** - * <pre> * setVisible(visible) -- Set's the control's visible/hidden state. * * visible : bool - True=visible / False=hidden. * * example: * - self.button.setVisible(False) - * </pre> */ virtual void setVisible(bool visible); // setVisibleCondition() Method /** - * <pre> * setVisibleCondition(visible[,allowHiddenFocus]) -- Set's the control's visible condition. * Allows XBMC to control the visible status of the control. * @@ -227,13 +212,11 @@ namespace XBMCAddon * * example: * - self.button.setVisibleCondition('[Control.IsVisible(41) + !Control.IsVisible(12)]', True)\n - * </pre> */ virtual void setVisibleCondition(const char* visible, bool allowHiddenFocus = false); // setEnableCondition() Method /** - * <pre> * setEnableCondition(enable) -- Set's the control's enabled condition. * Allows XBMC to control the enabled status of the control. * @@ -243,13 +226,11 @@ namespace XBMCAddon * * example: * - self.button.setEnableCondition('System.InternetState') - * </pre> */ virtual void setEnableCondition(const char* enable); // setAnimations() Method /** - * <pre> * setAnimations([(event, attr,)*]) -- Set's the control's animations. * * [(event,attr,)*] : list - A list of tuples consisting of event and attributes pairs. @@ -260,13 +241,11 @@ namespace XBMCAddon * * example: * - self.button.setAnimations([('focus', 'effect=zoom end=90,247,220,56 time=0',)])\n - * </pre> */ virtual void setAnimations(const std::vector< Tuple<String,String> >& eventAttr) throw (WindowException); // setPosition() Method /** - * <pre> * setPosition(x, y) -- Set's the controls position. * * x : integer - x coordinate of control. @@ -276,39 +255,33 @@ namespace XBMCAddon * * example: * - self.button.setPosition(100, 250)\n - * </pre> */ virtual void setPosition(long x, long y); // setWidth() Method /** - * <pre> * setWidth(width) -- Set's the controls width. * * width : integer - width of control. * * example: * - self.image.setWidth(100) - * </pre> */ virtual void setWidth(long width); // setHeight() Method /** - * <pre> * setHeight(height) -- Set's the controls height. * * height : integer - height of control. * * example: * - self.image.setHeight(100) - * </pre> */ virtual void setHeight(long height); // setNavigation() Method /** - * <pre> * setNavigation(up, down, left, right) -- Set's the controls navigation. * * up : control object - control to navigate to on up. @@ -324,7 +297,6 @@ namespace XBMCAddon * * example: * - self.button.setNavigation(self.button1, self.button2, self.button3, self.button4) - * </pre> */ virtual void setNavigation(const Control* up, const Control* down, const Control* left, const Control* right) @@ -332,7 +304,6 @@ namespace XBMCAddon // controlUp() Method /** - * <pre> * controlUp(control) -- Set's the controls up navigation. * * control : control object - control to navigate to on up. @@ -344,13 +315,11 @@ namespace XBMCAddon * * example: * - self.button.controlUp(self.button1) - * </pre> */ virtual void controlUp(const Control* up) throw (WindowException); // controlDown() Method /** - * <pre> * controlDown(control) -- Set's the controls down navigation. * * control : control object - control to navigate to on down. @@ -362,13 +331,11 @@ namespace XBMCAddon * * example: * - self.button.controlDown(self.button1) - * </pre> */ virtual void controlDown(const Control* control) throw (WindowException); // controlLeft() Method /** - * <pre> * controlLeft(control) -- Set's the controls left navigation. * * control : control object - control to navigate to on left. @@ -380,13 +347,11 @@ namespace XBMCAddon * * example: * - self.button.controlLeft(self.button1) - * </pre> */ virtual void controlLeft(const Control* control) throw (WindowException); // controlRight() Method /** - * <pre> * controlRight(control) -- Set's the controls right navigation. * * control : control object - control to navigate to on right. @@ -398,7 +363,6 @@ namespace XBMCAddon * * example: * - self.button.controlRight(self.button1)\n - * </pre> */ virtual void controlRight(const Control* control) throw (WindowException); @@ -419,13 +383,11 @@ namespace XBMCAddon }; /** - * <pre> * ControlSpin class. * * - Not working yet -. * * you can't create this object, it is returned by objects like ControlTextBox and ControlList. - * </pre> */ class ControlSpin : public Control { @@ -433,11 +395,9 @@ namespace XBMCAddon virtual ~ControlSpin(); /** - * <pre> * setTextures(up, down, upFocus, downFocus) -- Set's textures for this control. * * texture are image files that are used for example in the skin - * </pre> */ virtual void setTextures(const char* up, const char* down, const char* upFocus, @@ -459,7 +419,6 @@ namespace XBMCAddon }; /** - * <pre> * ControlLabel class. * * ControlLabel(x, y, width, height, label[, font, textColor, @@ -479,7 +438,6 @@ namespace XBMCAddon * * example: * - self.label = xbmcgui.ControlLabel(100, 250, 125, 75, 'Status', angle=45)\n - * </pre> */ class ControlLabel : public Control { @@ -493,24 +451,20 @@ namespace XBMCAddon virtual ~ControlLabel(); /** - * <pre> * getLabel() -- Returns the text value for this label. * * example: * - label = self.label.getLabel()\n - * </pre> */ virtual String getLabel() throw(UnimplementedException); /** - * <pre> * setLabel(label) -- Set's text for this label. * * label : string or unicode - text string. * * example: * - self.label.setLabel('Status') - * </pre> */ virtual void setLabel(const String& label = emptyString, const char* font = NULL, @@ -536,7 +490,6 @@ namespace XBMCAddon // ControlEdit class /** - * <pre> * ControlEdit class. * * ControlEdit(x, y, width, height, label[, font, textColor, @@ -561,7 +514,6 @@ namespace XBMCAddon * * example: * - self.edit = xbmcgui.ControlEdit(100, 250, 125, 75, 'Status') - * </pre> */ class ControlEdit : public Control { @@ -575,14 +527,12 @@ namespace XBMCAddon // setLabel() Method /** - * <pre> * setLabel(label) -- Set's text heading for this edit control. * * label : string or unicode - text string. * * example: * - self.edit.setLabel('Status')\n - * </pre> */ virtual void setLabel(const String& label = emptyString, const char* font = NULL, @@ -594,36 +544,30 @@ namespace XBMCAddon // getLabel() Method /** - * <pre> * getLabel() -- Returns the text heading for this edit control. * * example: * - label = self.edit.getLabel() - * </pre> */ virtual String getLabel() throw(UnimplementedException); // setText() Method /** - * <pre> * setText(value) -- Set's text value for this edit control. * * value : string or unicode - text string. * * example: * - self.edit.setText('online')\n - * </pre> */ virtual void setText(const String& text) throw(UnimplementedException); // getText() Method /** - * <pre> * getText() -- Returns the text value for this edit control. * * example: * - value = self.edit.getText() - * </pre> */ virtual String getText() throw(UnimplementedException); @@ -644,7 +588,6 @@ namespace XBMCAddon }; /** - * <pre> * ControlList class. * * ControlList(x, y, width, height[, font, textColor, buttonTexture, buttonFocusTexture, @@ -675,7 +618,6 @@ namespace XBMCAddon * * example: * - self.cList = xbmcgui.ControlList(100, 250, 200, 250, 'font14', space=5) - * </pre> */ class ControlList : public Control { @@ -691,42 +633,35 @@ namespace XBMCAddon virtual ~ControlList(); /** - * <pre> * addItem(item) -- Add a new item to this list control. * * item : string, unicode or ListItem - item to add. * * example: * - cList.addItem('Reboot XBMC') - * </pre> */ virtual void addItemStream(const String& fileOrUrl, bool sendMessage = true) throw(UnimplementedException,WindowException); virtual void addListItem(const XBMCAddon::xbmcgui::ListItem* listitem, bool sendMessage = true) throw(UnimplementedException,WindowException); /** - * <pre> * selectItem(item) -- Select an item by index number. * * item : integer - index number of the item to select. * * example: * - cList.selectItem(12) - * </pre> */ virtual void selectItem(long item) throw(UnimplementedException); /** - * <pre> * reset() -- Clear all ListItems in this control list. * * example: * - cList.reset()\n - * </pre> */ virtual void reset() throw (UnimplementedException); /** - * <pre> * getSpinControl() -- returns the associated ControlSpin object. * * *Note, Not working completely yet - @@ -735,24 +670,20 @@ namespace XBMCAddon * * example: * - ctl = cList.getSpinControl() - * </pre> */ virtual Control* getSpinControl() throw (UnimplementedException); /** - * <pre> * getSelectedPosition() -- Returns the position of the selected item as an integer. * * *Note, Returns -1 for empty lists. * * example: * - pos = cList.getSelectedPosition() - * </pre> */ virtual long getSelectedPosition() throw (UnimplementedException); /** - * <pre> * getSelectedItem() -- Returns the selected item as a ListItem object. * * *Note, Same as getSelectedPosition(), but instead of an integer a ListItem object @@ -761,14 +692,12 @@ namespace XBMCAddon * * example: * - item = cList.getSelectedItem() - * </pre> */ virtual XBMCAddon::xbmcgui::ListItem* getSelectedItem() throw (UnimplementedException); // setImageDimensions() method /** - * <pre> * setImageDimensions(imageWidth, imageHeight) -- Sets the width/height of items icon or thumbnail. * * imageWidth : [opt] integer - width of items icon or thumbnail. @@ -776,86 +705,72 @@ namespace XBMCAddon * * example: * - cList.setImageDimensions(18, 18)\n - * </pre> */ virtual void setImageDimensions(long imageWidth,long imageHeight) throw (UnimplementedException); // setItemHeight() method /** - * <pre> * setItemHeight(itemHeight) -- Sets the height of items. * * itemHeight : integer - height of items. * * example: * - cList.setItemHeight(25) - * </pre> */ virtual void setItemHeight(long height) throw (UnimplementedException); // setSpace() method /** - * <pre> * setSpace(space) -- Set's the space between items. * * space : [opt] integer - space between items. * * example: * - cList.setSpace(5) - * </pre> */ virtual void setSpace(int space) throw (UnimplementedException); // setPageControlVisible() method /** - * <pre> * setPageControlVisible(visible) -- Sets the spin control's visible/hidden state. * * visible : boolean - True=visible / False=hidden. * * example: * - cList.setPageControlVisible(True) - * </pre> */ virtual void setPageControlVisible(bool visible) throw(UnimplementedException); // size() method /** - * <pre> * size() -- Returns the total number of items in this list control as an integer. * * example: * - cnt = cList.size() - * </pre> */ virtual long size() throw (UnimplementedException); // getItemHeight() Method /** - * <pre> * getItemHeight() -- Returns the control's current item height as an integer. * * example: * - item_height = self.cList.getItemHeight()\n - * </pre> */ virtual long getItemHeight() throw(UnimplementedException); // getSpace() Method /** - * <pre> * getSpace() -- Returns the control's space between items as an integer. * * example: * - gap = self.cList.getSpace()\n - * </pre> */ virtual long getSpace() throw (UnimplementedException); // getListItem() method /** - * <pre> * getListItem(index) -- Returns a given ListItem in this List. * * index : integer - index number of item to return. @@ -864,12 +779,10 @@ namespace XBMCAddon * * example: * - listitem = cList.getListItem(6)\n - * </pre> */ virtual XBMCAddon::xbmcgui::ListItem* getListItem(int index) throw (UnimplementedException,WindowException); /** - * <pre> * setStaticContent(items) -- Fills a static list with a list of listitems. * * items : List - list of listitems to add. @@ -878,7 +791,6 @@ namespace XBMCAddon * * example: * - cList.setStaticContent(items=listitems)\n - * </pre> */ virtual void setStaticContent(const ListItemList* items) throw (UnimplementedException); @@ -916,7 +828,6 @@ namespace XBMCAddon // ControlFadeLabel class /** - * <pre> * ControlFadeLabel class. * Control that scroll's labl * @@ -936,7 +847,6 @@ namespace XBMCAddon * * example: * - self.fadelabel = xbmcgui.ControlFadeLabel(100, 250, 200, 50, textColor='0xFFFFFFFF') - * </pre> */ class ControlFadeLabel : public Control { @@ -948,24 +858,20 @@ namespace XBMCAddon // addLabel() Method /** - * <pre> * addLabel(label) -- Add a label to this control for scrolling. * * label : string or unicode - text string. * * example: * - self.fadelabel.addLabel('This is a line of text that can scroll.') - * </pre> */ virtual void addLabel(const String& label) throw (UnimplementedException); /** - * <pre> * reset() -- Clear this fade label. * * example: * - self.fadelabel.reset()\n - * </pre> */ virtual void reset() throw (UnimplementedException); @@ -982,7 +888,6 @@ namespace XBMCAddon }; /** - * <pre> * ControlTextBox class. * * ControlTextBox(x, y, width, height[, font, textColor]) @@ -1000,7 +905,6 @@ namespace XBMCAddon * * example: * - self.textbox = xbmcgui.ControlTextBox(100, 250, 300, 300, textColor='0xFFFFFFFF') - * </pre> */ class ControlTextBox : public Control { @@ -1011,38 +915,32 @@ namespace XBMCAddon // SetText() Method /** - * <pre> * setText(text) -- Set's the text for this textbox. * * text : string or unicode - text string. * * example: * - self.textbox.setText('This is a line of text that can wrap.') - * </pre> */ virtual void setText(const String& text) throw(UnimplementedException); // reset() Method /** - * <pre> * reset() -- Clear's this textbox. * * example: * - self.textbox.reset()\n - * </pre> */ virtual void reset() throw(UnimplementedException); // scroll() Method /** - * <pre> * scroll(position) -- Scrolls to the given position. * * id : integer - position to scroll to. * * example: * - self.textbox.scroll(10) - * </pre> */ virtual void scroll(long id) throw(UnimplementedException); @@ -1058,7 +956,6 @@ namespace XBMCAddon // ControlImage class /** - * <pre> * ControlImage class. * * ControlImage(x, y, width, height, filename[, aspectRatio, colorDiffuse]) @@ -1077,7 +974,6 @@ namespace XBMCAddon * * example: * - self.image = xbmcgui.ControlImage(100, 250, 125, 75, aspectRatio=2) - * </pre> */ class ControlImage : public Control { @@ -1087,26 +983,22 @@ namespace XBMCAddon const char* colorDiffuse = NULL); /** - * <pre> * setImage(filename) -- Changes the image. * * filename : string - image filename. * * example: * - self.image.setImage('special://home/scripts/test.png') - * </pre> */ virtual void setImage(const char* imageFilename) throw (UnimplementedException); /** - * <pre> * setColorDiffuse(colorDiffuse) -- Changes the images color. * * colorDiffuse : hexString - (example, '0xC0FF0000' (red tint)) * * example: * - self.image.setColorDiffuse('0xC0FF0000') - * </pre> */ virtual void setColorDiffuse(const char* hexString) throw (UnimplementedException); @@ -1132,7 +1024,6 @@ namespace XBMCAddon const char* textureoverlay = NULL); /** - * <pre> * setPercent(percent) -- Sets the percentage of the progressbar to show. * * percent : float - percentage of the bar to show. @@ -1141,17 +1032,14 @@ namespace XBMCAddon * * example: * - self.progress.setPercent(60) - * </pre> */ virtual void setPercent(float pct) throw (UnimplementedException); /** - * <pre> * getPercent() -- Returns a float of the percent of the progress. * * example: * - print self.progress.getValue() - * </pre> */ virtual float getPercent() throw (UnimplementedException); @@ -1171,7 +1059,6 @@ namespace XBMCAddon // ControlButton class /** - * <pre> * ControlButton class. * * ControlButton(x, y, width, height, label[, focusTexture, noFocusTexture, textOffsetX, textOffsetY, @@ -1200,7 +1087,6 @@ namespace XBMCAddon * * example: * - self.button = xbmcgui.ControlButton(100, 250, 200, 50, 'Status', font='font14') - * </pre> */ class ControlButton : public Control { @@ -1216,7 +1102,6 @@ namespace XBMCAddon // setLabel() Method /** - * <pre> * setLabel([label, font, textColor, disabledColor, shadowColor, focusedColor]) -- Set's this buttons text attributes. * * label : [opt] string or unicode - text string. @@ -1232,7 +1117,6 @@ namespace XBMCAddon * * example: * - self.button.setLabel('Status', 'font14', '0xFFFFFFFF', '0xFFFF3300', '0xFF000000') - * </pre> */ virtual void setLabel(const String& label = emptyString, const char* font = NULL, @@ -1244,36 +1128,30 @@ namespace XBMCAddon // setDisabledColor() Method /** - * <pre> * setDisabledColor(disabledColor) -- Set's this buttons disabled color. * * disabledColor : hexstring - color of disabled button's label. (e.g. '0xFFFF3300') * * example: * - self.button.setDisabledColor('0xFFFF3300') - * </pre> */ virtual void setDisabledColor(const char* color) throw (UnimplementedException); // getLabel() Method /** - * <pre> * getLabel() -- Returns the buttons label as a unicode string. * * example: * - label = self.button.getLabel() - * </pre> */ virtual String getLabel() throw (UnimplementedException); // getLabel2() Method /** - * <pre> * getLabel2() -- Returns the buttons label2 as a unicode string. * * example: * - label = self.button.getLabel2() - * </pre> */ virtual String getLabel2() throw (UnimplementedException); #ifndef SWIG @@ -1301,7 +1179,6 @@ namespace XBMCAddon // ControlCheckMark class /** - * <pre> * ControlCheckMark class. * * ControlCheckMark(x, y, width, height, label[, focusTexture, noFocusTexture, @@ -1327,7 +1204,6 @@ namespace XBMCAddon * * example: * - self.checkmark = xbmcgui.ControlCheckMark(100, 250, 200, 50, 'Status', font='font14') - * </pre> */ class ControlCheckMark : public Control { @@ -1341,31 +1217,26 @@ namespace XBMCAddon // getSelected() Method /** - * <pre> * getSelected() -- Returns the selected status for this checkmark as a bool. * * example: * - selected = self.checkmark.getSelected() - * </pre> */ virtual bool getSelected() throw (UnimplementedException); // setSelected() Method /** - * <pre> * setSelected(isOn) -- Sets this checkmark status to on or off. * * isOn : bool - True=selected (on) / False=not selected (off) * * example: * - self.checkmark.setSelected(True) - * </pre> */ virtual void setSelected(bool selected) throw (UnimplementedException); // setLabel() Method /** - * <pre> * setLabel(label[, font, textColor, disabledColor]) -- Set's this controls text attributes. * * label : string or unicode - text string. @@ -1375,7 +1246,6 @@ namespace XBMCAddon * * example: * - self.checkmark.setLabel('Status', 'font14', '0xFFFFFFFF', '0xFFFF3300') - * </pre> */ virtual void setLabel(const String& label = emptyString, const char* font = NULL, @@ -1387,14 +1257,12 @@ namespace XBMCAddon // setDisabledColor() Method /** - * <pre> * setDisabledColor(disabledColor) -- Set's this controls disabled color. * * disabledColor : hexstring - color of disabled checkmark's label. (e.g. '0xFFFF3300') * * example: * - self.checkmark.setDisabledColor('0xFFFF3300') - * </pre> */ virtual void setDisabledColor(const char* color) throw (UnimplementedException); @@ -1419,7 +1287,6 @@ namespace XBMCAddon // ControlGroup class /** - * <pre> * ControlGroup class. * * ControlGroup(x, y, width, height @@ -1430,7 +1297,6 @@ namespace XBMCAddon * height : integer - height of control. * example: * - self.group = xbmcgui.ControlGroup(100, 250, 125, 75) - * </pre> */ class ControlGroup : public Control { @@ -1460,7 +1326,6 @@ namespace XBMCAddon // setSelected() Method /** - * <pre> * setSelected(selected) -- Sets the radio buttons's selected status. * * selected : bool - True=selected (on) / False=not selected (off) @@ -1470,24 +1335,20 @@ namespace XBMCAddon * * example: * - self.radiobutton.setSelected(True) - * </pre> */ virtual void setSelected(bool selected) throw (UnimplementedException); // isSelected() Method /** - * <pre> * isSelected() -- Returns the radio buttons's selected status. * * example: * - is = self.radiobutton.isSelected()\n - * </pre> */ virtual bool isSelected() throw (UnimplementedException); // setLabel() Method /** - * <pre> * setLabel(label[, font, textColor, disabledColor, shadowColor, focusedColor]) -- Set's the radio buttons text attributes. * * label : string or unicode - text string. @@ -1502,7 +1363,6 @@ namespace XBMCAddon * * example: * - self.radiobutton.setLabel('Status', 'font14', '0xFFFFFFFF', '0xFFFF3300', '0xFF000000') - * </pre> */ virtual void setLabel(const String& label = emptyString, const char* font = NULL, @@ -1514,7 +1374,6 @@ namespace XBMCAddon // setRadioDimension() Method /** - * <pre> * setRadioDimension(x, y, width, height) -- Sets the radio buttons's radio texture's position and size. * * x : integer - x coordinate of radio texture. @@ -1527,7 +1386,6 @@ namespace XBMCAddon * * example: * - self.radiobutton.setRadioDimension(x=100, y=5, width=20, height=20) - * </pre> */ virtual void setRadioDimension(long x, long y, long width, long height) throw (UnimplementedException); @@ -1556,7 +1414,6 @@ namespace XBMCAddon }; /** - * <pre> * ControlSlider class. * * ControlSlider(x, y, width, height[, textureback, texture, texturefocus]) @@ -1574,7 +1431,6 @@ namespace XBMCAddon * * example: * - self.slider = xbmcgui.ControlSlider(100, 250, 350, 40) - * </pre> */ class ControlSlider : public Control { @@ -1585,22 +1441,18 @@ namespace XBMCAddon const char* texturefocus = NULL); /** - * <pre> * getPercent() -- Returns a float of the percent of the slider. * * example: * - print self.slider.getPercent() - * </pre> */ virtual float getPercent() throw (UnimplementedException); /** - * <pre> * setPercent(50) -- Sets the percent of the slider. * * example: * self.slider.setPercent(50) - * </pre> */ virtual void setPercent(float pct) throw (UnimplementedException); diff --git a/xbmc/interfaces/legacy/Dialog.h b/xbmc/interfaces/legacy/Dialog.h index adf57d040e..9c779f1cde 100644 --- a/xbmc/interfaces/legacy/Dialog.h +++ b/xbmc/interfaces/legacy/Dialog.h @@ -35,9 +35,7 @@ namespace XBMCAddon namespace xbmcgui { /** - * <pre> * Dialog class (Duh!) - * </pre> */ class Dialog : public AddonClass { @@ -47,7 +45,6 @@ namespace XBMCAddon virtual ~Dialog(); /** - * <pre> * yesno(heading, line1[, line2, line3]) -- Show a dialog 'YES/NO'. * * heading : string or unicode - dialog heading. @@ -62,7 +59,6 @@ namespace XBMCAddon * example: * - dialog = xbmcgui.Dialog() * - ret = dialog.yesno('XBMC', 'Do you want to exit this script?')\n - * </pre> */ bool yesno(const String& heading, const String& line1, const String& line2 = emptyString, @@ -71,7 +67,6 @@ namespace XBMCAddon const String& yeslabel = emptyString) throw (WindowException); /** - * <pre> * select(heading, list) -- Show a select dialog. * * heading : string or unicode - dialog heading. @@ -83,12 +78,10 @@ namespace XBMCAddon * example: * - dialog = xbmcgui.Dialog() * - ret = dialog.select('Choose a playlist', ['Playlist #1', 'Playlist #2, 'Playlist #3'])\n - * </pre> */ int select(const String& heading, const std::vector<String>& list, int autoclose=0) throw (WindowException); /** - * <pre> * ok(heading, line1[, line2, line3]) -- Show a dialog 'OK'. * * heading : string or unicode - dialog heading. @@ -101,14 +94,12 @@ namespace XBMCAddon * example: * - dialog = xbmcgui.Dialog() * - ok = dialog.ok('XBMC', 'There was an error.')\n - * </pre> */ bool ok(const String& heading, const String& line1, const String& line2 = emptyString, const String& line3 = emptyString) throw (WindowException); /** - * <pre> * browse(type, heading, shares[, mask, useThumbs, treatAsFolder, default, enableMultiple]) -- Show a 'Browse' dialog. * * type : integer - the type of browse dialog. @@ -137,7 +128,6 @@ namespace XBMCAddon * example: * - dialog = xbmcgui.Dialog() * - fn = dialog.browse(3, 'XBMC', 'files', '', False, False, False, 'special://masterprofile/script_data/XBMC Lyrics') - * </pre> */ Alternative<String, std::vector<String> > browse(int type, const String& heading, const String& s_shares, const String& mask = emptyString, bool useThumbs = false, @@ -145,7 +135,6 @@ namespace XBMCAddon bool enableMultiple = false) throw (WindowException); /** - * <pre> * browse(type, heading, shares[, mask, useThumbs, treatAsFolder, default]) -- Show a 'Browse' dialog. * * type : integer - the type of browse dialog. @@ -169,7 +158,6 @@ namespace XBMCAddon * example: * - dialog = xbmcgui.Dialog() * - fn = dialog.browse(3, 'XBMC', 'files', '', False, False, 'special://masterprofile/script_data/XBMC Lyrics')\n - * </pre> */ String browseSingle(int type, const String& heading, const String& shares, const String& mask = emptyString, bool useThumbs = false, @@ -177,7 +165,6 @@ namespace XBMCAddon const String& defaultt = emptyString ) throw (WindowException); /** - * <pre> * browse(type, heading, shares[, mask, useThumbs, treatAsFolder, default]) -- Show a 'Browse' dialog. * * type : integer - the type of browse dialog. @@ -199,7 +186,6 @@ namespace XBMCAddon * example: * - dialog = xbmcgui.Dialog() * - fn = dialog.browseMultiple(2, 'XBMC', 'files', '', False, False, 'special://masterprofile/script_data/XBMC Lyrics')\n - * </pre> */ std::vector<String> browseMultiple(int type, const String& heading, const String& shares, const String& mask = emptyString, bool useThumbs = false, @@ -208,7 +194,6 @@ namespace XBMCAddon /** - * <pre> * numeric(type, heading[, default]) -- Show a 'Numeric' dialog. * * type : integer - the type of numeric dialog. @@ -227,16 +212,13 @@ namespace XBMCAddon * example: * - dialog = xbmcgui.Dialog() * - d = dialog.numeric(1, 'Enter date of birth')\n - * </pre> */ String numeric(int type, const String& heading, const String& defaultt = emptyString); }; /** - * <pre> * DialogProgress class (Duh!) - * </pre> */ class DialogProgress : public AddonClass { @@ -252,7 +234,6 @@ namespace XBMCAddon /** - * <pre> * create(heading[, line1, line2, line3]) -- Create and show a progress dialog. * * heading : string or unicode - dialog heading. @@ -265,14 +246,12 @@ namespace XBMCAddon * example: * - pDialog = xbmcgui.DialogProgress() * - pDialog.create('XBMC', 'Initializing script...') - * </pre> */ void create(const String& heading, const String& line1 = emptyString, const String& line2 = emptyString, const String& line3 = emptyString) throw (WindowException); /** - * <pre> * update(percent[, line1, line2, line3]) -- Update's the progress dialog. * * percent : integer - percent complete. (0:100) @@ -284,29 +263,24 @@ namespace XBMCAddon * * example: * - pDialog.update(25, 'Importing modules...') - * </pre> */ void update(int percent, const String& line1 = emptyString, const String& line2 = emptyString, const String& line3 = emptyString) throw (WindowException); /** - * <pre> * close() -- Close the progress dialog. * * example: * - pDialog.close() - * </pre> */ void close(); /** - * <pre> * iscanceled() -- Returns True if the user pressed cancel. * * example: * - if (pDialog.iscanceled()): return - * </pre> */ bool iscanceled(); }; diff --git a/xbmc/interfaces/legacy/File.h b/xbmc/interfaces/legacy/File.h index 87b0e4a385..b002e8b69c 100644 --- a/xbmc/interfaces/legacy/File.h +++ b/xbmc/interfaces/legacy/File.h @@ -33,13 +33,11 @@ namespace XBMCAddon { /** - * <pre> * File class. * * 'w' - opt open for write * example: * f = xbmcvfs.File(file, ['w']) - * </pre> */ class File : public AddonClass { @@ -58,7 +56,6 @@ namespace XBMCAddon #ifndef SWIG /** - * <pre> * read(bytes) * * bytes : how many bytes to read [opt]- if not set it will read the whole fi @@ -67,13 +64,11 @@ namespace XBMCAddon * f = xbmcvfs.File(file) * b = f.read() * f.close() - * </pre> */ unsigned long read(void* buffer, unsigned long numBytes = 0); #endif /** - * <pre> * write(buffer) * * buffer : buffer to write to fi @@ -82,24 +77,20 @@ namespace XBMCAddon * f = xbmcvfs.File(file, 'w', True) * result = f.write(buffer) * f.close() - * </pre> */ bool write(const char* file); /** - * <pre> * size() * * example: * f = xbmcvfs.File(file) * s = f.size() * f.close() - * </pre> */ inline long long size() { DelayedCallGuard dg(languageHook); return file->GetLength(); } /** - * <pre> * seek() * * FilePosition : position in the file @@ -108,18 +99,15 @@ namespace XBMCAddon * f = xbmcvfs.File(file) * result = f.seek(8129, 0) * f.close() - * </pre> */ inline long long seek(long long seekBytes, int iWhence) { DelayedCallGuard dg(languageHook); return file->Seek(seekBytes,iWhence); } /** - * <pre> * close() * * example: * f = xbmcvfs.File(file) * f.close() - * </pre> */ inline void close() { DelayedCallGuard dg(languageHook); file->Close(); } diff --git a/xbmc/interfaces/legacy/InfoTagVideo.h b/xbmc/interfaces/legacy/InfoTagVideo.h index aa1431c312..e649e4ee3f 100644 --- a/xbmc/interfaces/legacy/InfoTagVideo.h +++ b/xbmc/interfaces/legacy/InfoTagVideo.h @@ -57,16 +57,12 @@ namespace XBMCAddon double getRating(); /** - * <pre> * getPlayCount() -- returns a integer. - * </pre> */ int getPlayCount(); /** - * <pre> * getLastPlayed() -- returns a string. - * </pre> */ String getLastPlayed(); String getOriginalTitle(); diff --git a/xbmc/interfaces/legacy/Keyboard.h b/xbmc/interfaces/legacy/Keyboard.h index 536831893d..37fa266160 100644 --- a/xbmc/interfaces/legacy/Keyboard.h +++ b/xbmc/interfaces/legacy/Keyboard.h @@ -34,7 +34,6 @@ namespace XBMCAddon XBMCCOMMONS_STANDARD_EXCEPTION(KeyboardException); /** - * <pre> * Keyboard class. * * Keyboard([default, heading, hidden]) -- Creates a new Keyboard object with default text @@ -52,7 +51,6 @@ namespace XBMCAddon * - kb.doModal() * - if (kb.isConfirmed()): * - text = kb.getText() - * </pre> */ class Keyboard : public AddonClass { @@ -66,57 +64,48 @@ namespace XBMCAddon virtual ~Keyboard(); /** - * <pre> * doModal([autoclose]) -- Show keyboard and wait for user action. * * autoclose : [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose) * * example: * - kb.doModal(30000) - * </pre> */ void doModal(int autoclose = 0) throw (KeyboardException); // setDefault() Method /** - * <pre> * setDefault(default) -- Set the default text entry. * * default : string - default text entry. * * example: * - kb.setDefault('password') - * </pre> */ void setDefault(const String& line = emptyString) throw (KeyboardException); /** - * <pre> * setHiddenInput(hidden) -- Allows hidden text entry. * * hidden : boolean - True for hidden text entry. * example: * - kb.setHiddenInput(True) - * </pre> */ void setHiddenInput(bool hidden = false) throw (KeyboardException); // setHeading() Method /** - * <pre> * setHeading(heading) -- Set the keyboard heading. * * heading : string - keyboard heading. * * example: * - kb.setHeading('Enter password') - * </pre> */ void setHeading(const String& heading) throw (KeyboardException); // getText() Method /** - * <pre> * getText() -- Returns the user input as a string. * * *Note, This will always return the text entry even if you cancel the keyboard. @@ -124,18 +113,15 @@ namespace XBMCAddon * * example: * - text = kb.getText() - * </pre> */ String getText() throw (KeyboardException); // isConfirmed() Method /** - * <pre> * isConfirmed() -- Returns False if the user cancelled the input. * * example: * - if (kb.isConfirmed()): - * </pre> */ bool isConfirmed() throw (KeyboardException); diff --git a/xbmc/interfaces/legacy/ListItem.h b/xbmc/interfaces/legacy/ListItem.h index 29760147a5..33d674086a 100644 --- a/xbmc/interfaces/legacy/ListItem.h +++ b/xbmc/interfaces/legacy/ListItem.h @@ -69,97 +69,80 @@ namespace XBMCAddon } /** - * <pre> * getLabel() -- Returns the listitem label. * * example: * - label = self.list.getSelectedItem().getLabel() - * </pre> */ String getLabel(); /** - * <pre> * getLabel2() -- Returns the listitem label. * * example: * - label = self.list.getSelectedItem().getLabel2() - * </pre> */ String getLabel2(); /** - * <pre> * setLabel(label) -- Sets the listitem's label. * * label : string or unicode - text string. * * example: * - self.list.getSelectedItem().setLabel('Casino Royale') - * </pre> */ void setLabel(const String& label); /** - * <pre> * setLabel2(label) -- Sets the listitem's label2. * * label : string or unicode - text string. * * example: * - self.list.getSelectedItem().setLabel2('Casino Royale') - * </pre> */ void setLabel2(const String& label); /** - * <pre> * setIconImage(icon) -- Sets the listitem's icon image. * * icon : string - image filename. * * example: * - self.list.getSelectedItem().setIconImage('emailread.png') - * </pre> */ void setIconImage(const String& iconImage); /** - * <pre> * setThumbnailImage(thumbFilename) -- Sets the listitem's thumbnail image. * * thumb : string - image filename. * * example: * - self.list.getSelectedItem().setThumbnailImage('emailread.png') - * </pre> */ void setThumbnailImage(const String& thumbFilename); /** - * <pre> * select(selected) -- Sets the listitem's selected status. * * selected : bool - True=selected/False=not selected * * example: * - self.list.getSelectedItem().select(True) - * </pre> */ void select(bool selected); /** - * <pre> * isSelected() -- Returns the listitem's selected status. * * example: * - is = self.list.getSelectedItem().isSelected() - * </pre> */ bool isSelected(); /** - * <pre> * setInfo(type, infoLabels) -- Sets the listitem's infoLabels. * * type : string - type of media(video/music/pictures). @@ -233,12 +216,10 @@ namespace XBMCAddon * * example: * - self.list.getSelectedItem().setInfo('video', { 'Genre': 'Comedy' })\n - * </pre> */ void setInfo(const char* type, const Dictionary& infoLabels); /** - * <pre> * addStreamInfo(type, values) -- Add a stream with details. * * type : string - type of stream(video/audio/subtitle). @@ -261,12 +242,10 @@ namespace XBMCAddon * * example: * - self.list.getSelectedItem().addStreamInfo('video', { 'Codec': 'h264', 'Width' : 1280 }) - * </pre> */ void addStreamInfo(const char* cType, const Dictionary& dictionary); /** - * <pre> * addContextMenuItems([(label, action,)*], replaceItems) -- Adds item(s) to the context menu for media lists. * * items : list - [(label, action,)*] A list of tuples consisting of label and action pairs. @@ -281,12 +260,10 @@ namespace XBMCAddon * * example: * - listitem.addContextMenuItems([('Theater Showtimes', 'XBMC.RunScript(special://home/scripts/showtimes/default.py,Iron Man)',)])\n - * </pre> */ void addContextMenuItems(const std::vector<Tuple<String,String> >& items, bool replaceItems = false) throw (ListItemException); /** - * <pre> * setProperty(key, value) -- Sets a listitem property, similar to an infolabel. * * key : string - property name. @@ -303,12 +280,10 @@ namespace XBMCAddon * example: * - self.list.getSelectedItem().setProperty('AspectRatio', '1.85 : 1') * - self.list.getSelectedItem().setProperty('StartOffset', '256.4') - * </pre> */ void setProperty(const char * key, const String& value); /** - * <pre> * getProperty(key) -- Returns a listitem property as a string, similar to an infolabel. * * key : string - property name. @@ -319,12 +294,10 @@ namespace XBMCAddon * * example: * - AspectRatio = self.list.getSelectedItem().getProperty('AspectRatio') - * </pre> */ String getProperty(const char* key); /** - * <pre> * addContextMenuItems([(label, action,)*], replaceItems) -- Adds item(s) to the context menu for media lists. * * items : list - [(label, action,)*] A list of tuples consisting of label and action pairs. @@ -339,12 +312,10 @@ namespace XBMCAddon * * example: * - listitem.addContextMenuItems([('Theater Showtimes', 'XBMC.RunScript(special://home/scripts/showtimes/default.py,Iron Man)',)]) - * </pre> */ // void addContextMenuItems(); /** - * <pre> * setPath(path) -- Sets the listitem's path. * * path : string or unicode - path, activated when item is clicked. @@ -353,39 +324,30 @@ namespace XBMCAddon * * example: * - self.list.getSelectedItem().setPath(path='ActivateWindow(Weather)') - * </pre> */ void setPath(const String& path); /** - * <pre> * setMimeType(mimetype) -- Sets the listitem's mimetype if known. * * mimetype : string or unicode - mimetype. * * *If known prehand, this can avoid xbmc doing HEAD requests to http servers to figure out file type. - * </pre> */ void setMimeType(const String& mimetype); /** - * <pre> * getdescription() -- Returns the description of this PlayListItem. - * </pre> */ String getdescription(); /** - * <pre> * getduration() -- Returns the duration of this PlayListItem - * </pre> */ String getduration(); /** - * <pre> * getfilename() -- Returns the filename of this PlayListItem. - * </pre> */ String getfilename(); diff --git a/xbmc/interfaces/legacy/ModuleXbmc.h b/xbmc/interfaces/legacy/ModuleXbmc.h index 8687f68379..c640b2aa19 100644 --- a/xbmc/interfaces/legacy/ModuleXbmc.h +++ b/xbmc/interfaces/legacy/ModuleXbmc.h @@ -39,7 +39,6 @@ namespace XBMCAddon #endif /** - * <pre> * log(msg[, level]) -- Write a string to XBMC's log file and the debug window. * msg : string - text to output. * level : [opt] integer - log level to ouput at. (default=LOGNOTICE) @@ -55,43 +54,35 @@ namespace XBMCAddon * * example: * - xbmc.output(msg='This is a test string.', level=xbmc.LOGDEBUG)); - * </pre> */ void log(const char* msg, int level = lLOGNOTICE); /** - * <pre> * Shutdown() -- Shutdown the xbox. * * example: * - xbmc.shutdown() - * </pre> */ void shutdown(); /** - * <pre> * restart() -- Restart the xbox. * example: * - xbmc.restart() - * </pre> */ void restart(); /** - * <pre> * executescript(script) -- Execute a python script. * * script : string - script filename to execute. * * example: * - xbmc.executescript('special://home/scripts/update.py') - * </pre> */ void executescript(const char* script); /** - * <pre> * executebuiltin(function) -- Execute a built in XBMC function. * * function : string - builtin function to execute. @@ -100,19 +91,15 @@ namespace XBMCAddon * * example: * - xbmc.executebuiltin('XBMC.RunXBE(c:\\\\avalaunch.xbe)') - * </pre> */ void executebuiltin(const char* function, bool wait = false); /** - * <pre> * executehttpapi(httpcommand) -- Not implemented anymore. - * </pre> */ String executehttpapi(const char* httpcommand); /** - * <pre> * executeJSONRPC(jsonrpccommand) -- Execute an JSONRPC command. * * jsonrpccommand : string - jsonrpc command to execute. @@ -121,12 +108,10 @@ namespace XBMCAddon * * example: * - response = xbmc.executeJSONRPC('{ \"jsonrpc\": \"2.0\", \"method\": \"JSONRPC.Introspect\", \"id\": 1 }') - * </pre> */ String executeJSONRPC(const char* jsonrpccommand); /** - * <pre> * sleep(time) -- Sleeps for 'time' msec. * * time : integer - number of msec to sleep. @@ -138,12 +123,10 @@ namespace XBMCAddon * * example: * - xbmc.sleep(2000) # sleeps for 2 seconds - * </pre> */ void sleep(long timemillis); /** - * <pre> * getLocalizedString(id) -- Returns a localized 'unicode string'. * * id : integer - id# for string you want to localize. @@ -153,44 +136,36 @@ namespace XBMCAddon * * example: * - locstr = xbmc.getLocalizedString(6) - * </pre> */ String getLocalizedString(int id); /** - * <pre> * getSkinDir() -- Returns the active skin directory as a string. * * *Note, This is not the full path like 'special://home/addons/MediaCenter', but only 'MediaCenter'. * * example: * - skindir = xbmc.getSkinDir() - * </pre> */ String getSkinDir(); /** - * <pre> * getLanguage() -- Returns the active language as a string. * * example: * - language = xbmc.getLanguage() - * </pre> */ String getLanguage(); /** - * <pre> * getIPAddress() -- Returns the current ip address as a string. * * example: * - ip = xbmc.getIPAddress() - * </pre> */ String getIPAddress(); /** - * <pre> * getDVDState() -- Returns the dvd state as an integer. * * return values are: @@ -201,22 +176,18 @@ namespace XBMCAddon * * example: * - dvdstate = xbmc.getDVDState() - * </pre> */ long getDVDState(); /** - * <pre> * getFreeMem() -- Returns the amount of free memory in MB as an integer. * * example: * - freemem = xbmc.getFreeMem() - * </pre> */ long getFreeMem(); /** - * <pre> * getInfoLabel(infotag) -- Returns an InfoLabel as a string. * * infotag : string - infoTag for value you want returned. @@ -225,12 +196,10 @@ namespace XBMCAddon * * example: * - label = xbmc.getInfoLabel('Weather.Conditions') - * </pre> */ String getInfoLabel(const char* cLine); /** - * <pre> * getInfoImage(infotag) -- Returns a filename including path to the InfoImage's * thumbnail as a string. * @@ -240,36 +209,30 @@ namespace XBMCAddon * * example: * - filename = xbmc.getInfoImage('Weather.Conditions') - * </pre> */ String getInfoImage(const char * infotag); /** - * <pre> * playSFX(filename) -- Plays a wav file by filename * * filename : string - filename of the wav file to play. * * example: * - xbmc.playSFX('special://xbmc/scripts/dingdong.wav') - * </pre> */ void playSFX(const char* filename); /** - * <pre> * enableNavSounds(yesNo) -- Enables/Disables nav sounds * * yesNo : integer - enable (True) or disable (False) nav sounds * * example: * - xbmc.enableNavSounds(True) - * </pre> */ void enableNavSounds(bool yesNo); /** - * <pre> * getCondVisibility(condition) -- Returns True (1) or False (0) as a bool. * * condition : string - condition to check. @@ -281,34 +244,28 @@ namespace XBMCAddon * * example: * - visible = xbmc.getCondVisibility('[Control.IsVisible(41) + !Control.IsVisible(12)]') - * </pre> */ bool getCondVisibility(const char *condition); /** - * <pre> * getGlobalIdleTime() -- Returns the elapsed idle time in seconds as an integer. * * example: * - t = xbmc.getGlobalIdleTime() - * </pre> */ int getGlobalIdleTime(); /** - * <pre> * getCacheThumbName(path) -- Returns a thumb cache filename. * * path : string or unicode - path to file * * example: * - thumb = xbmc.getCacheThumbName('f:\\\\videos\\\\movie.avi') - * </pre> */ String getCacheThumbName(const String& path); /** - * <pre> * makeLegalFilename(filename[, fatX]) -- Returns a legal filename or path as a string. * * filename : string or unicode - filename/path to make legal @@ -322,12 +279,10 @@ namespace XBMCAddon * * example: * - filename = xbmc.makeLegalFilename('F:\\Trailers\\Ice Age: The Meltdown.avi') - * </pre> */ String makeLegalFilename(const String& filename,bool fatX = true); /** - * <pre> * translatePath(path) -- Returns the translated path. * * path : string or unicode - Path to format @@ -338,12 +293,10 @@ namespace XBMCAddon * * example: * - fpath = xbmc.translatePath('special://masterprofile/script_data') - * </pre> */ String translatePath(const String& path); /** - * <pre> * getCleanMovieTitle(path[, usefoldername]) -- Returns a clean movie title and year string if available. * * path : string or unicode - String to clean @@ -351,12 +304,10 @@ namespace XBMCAddon * * example: * - title, year = xbmc.getCleanMovieTitle('/path/to/moviefolder/test.avi', True) - * </pre> */ Tuple<String,String> getCleanMovieTitle(const String& path, bool usefoldername = false); /** - * <pre> * validatePath(path) -- Returns the validated path. * * path : string or unicode - Path to format @@ -366,12 +317,10 @@ namespace XBMCAddon * * example: * - fpath = xbmc.validatePath(somepath) - * </pre> */ String validatePath(const String& path); /** - * <pre> * getRegion(id) -- Returns your regions setting as a string for the specified id. * * id : string - id of setting to return @@ -382,12 +331,10 @@ namespace XBMCAddon * * example: * - date_long_format = xbmc.getRegion('datelong') - * </pre> */ String getRegion(const char* id); /** - * <pre> * getSupportedMedia(media) -- Returns the supported file types for the specific media as a string. * * media : string - media type @@ -400,12 +347,10 @@ namespace XBMCAddon * * example: * - mTypes = xbmc.getSupportedMedia('video') - * </pre> */ String getSupportedMedia(const char* mediaType); /** - * <pre> * skinHasImage(image) -- Returns True if the image file exists in the skin. * * image : string - image filename @@ -416,12 +361,10 @@ namespace XBMCAddon * * example: * - exists = xbmc.skinHasImage('ButtonFocusedTexture.png') - * </pre> */ bool skinHasImage(const char* image); /** - * <pre> * startServer(typ, bStart, bWait) -- start or stop a server. * * typ : integer - use SERVER_* constants @@ -433,27 +376,22 @@ namespace XBMCAddon * returnValue : bool - True or False * example: * - xbmc.startServer(xbmc.SERVER_AIRPLAYSERVER, False) - * </pre> */ bool startServer(int iTyp, bool bStart, bool bWait = false); /** - * <pre> * audioSuspend() -- Suspend Audio engine. * * example: * xbmc.audioSuspend() - * </pre> */ void audioSuspend(); /** - * <pre> * audioResume() -- Resume Audio engine. * * example: * xbmc.audioResume() - * </pre> */ void audioResume(); diff --git a/xbmc/interfaces/legacy/ModuleXbmcgui.h b/xbmc/interfaces/legacy/ModuleXbmcgui.h index a0e8344b8c..3f5c40aff9 100644 --- a/xbmc/interfaces/legacy/ModuleXbmcgui.h +++ b/xbmc/interfaces/legacy/ModuleXbmcgui.h @@ -26,7 +26,6 @@ namespace XBMCAddon namespace xbmcgui { /** - * <pre> * lock() -- Lock the gui until xbmcgui.unlock() is called. * * *Note, This will improve performance when doing a lot of gui manipulation at once. @@ -34,37 +33,30 @@ namespace XBMCAddon * * example: * - xbmcgui.lock() - * </pre> */ void lock(); /** - * <pre> * unlock() -- Unlock the gui from a lock() call. * * example: * - xbmcgui.unlock() - * </pre> */ void unlock(); /** - * <pre> * getCurrentWindowId() -- Returns the id for the current 'active' window as an integer. * * example: * - wid = xbmcgui.getCurrentWindowId() - * </pre> */ long getCurrentWindowId(); /** - * <pre> * getCurrentWindowDialogId() -- Returns the id for the current 'active' dialog as an integer. * * example: * - wid = xbmcgui.getCurrentWindowDialogId() - * </pre> */ long getCurrentWindowDialogId(); diff --git a/xbmc/interfaces/legacy/ModuleXbmcplugin.h b/xbmc/interfaces/legacy/ModuleXbmcplugin.h index f020c09303..8d05f6a02c 100644 --- a/xbmc/interfaces/legacy/ModuleXbmcplugin.h +++ b/xbmc/interfaces/legacy/ModuleXbmcplugin.h @@ -34,7 +34,6 @@ namespace XBMCAddon namespace xbmcplugin { /** - * <pre> * addDirectoryItem(handle, url, listitem [,isFolder, totalItems]) -- Callback function to pass directory contents back to XBMC. * - Returns a bool for successful completion. * @@ -49,13 +48,11 @@ namespace XBMCAddon * * example: * - if not xbmcplugin.addDirectoryItem(int(sys.argv[1]), 'F:\\\\Trailers\\\\300.mov', listitem, totalItems=50): break - * </pre> */ bool addDirectoryItem(int handle, const String& url, const XBMCAddon::xbmcgui::ListItem* listitem, bool isFolder = false, int totalItems = 0); /** - * <pre> * addDirectoryItems(handle, items [,totalItems]) -- Callback function to pass directory contents back to XBMC as a list. * - Returns a bool for successful completion. * @@ -68,14 +65,12 @@ namespace XBMCAddon * * example: * - if not xbmcplugin.addDirectoryItems(int(sys.argv[1]), [(url, listitem, False,)]: raise - * </pre> */ bool addDirectoryItems(int handle, const std::vector<Tuple<String,const XBMCAddon::xbmcgui::ListItem*,bool> >& items, int totalItems = 0); /** - * <pre> * endOfDirectory(handle[, succeeded, updateListing, cacheToDisc]) -- Callback function to tell XBMC that the end of the directory listing in a virtualPythonFolder module is reached. * * handle : integer - handle the plugin was started with. @@ -85,13 +80,11 @@ namespace XBMCAddon * * example: * - xbmcplugin.endOfDirectory(int(sys.argv[1]), cacheToDisc=False) - * </pre> */ void endOfDirectory(int handle, bool succeeded = true, bool updateListing = false, bool cacheToDisc = true); /** - * <pre> * setResolvedUrl(handle, succeeded, listitem) -- Callback function to tell XBMC that the file plugin has been resolved to a url * * handle : integer - handle the plugin was started with. @@ -100,12 +93,10 @@ namespace XBMCAddon * * example: * - xbmcplugin.setResolvedUrl(int(sys.argv[1]), True, listitem) - * </pre> */ void setResolvedUrl(int handle, bool succeeded, const XBMCAddon::xbmcgui::ListItem* listitem); /** - * <pre> * addSortMethod(handle, sortMethod, label2) -- Adds a sorting method for the media list. * * handle : integer - handle the plugin was started with. @@ -118,12 +109,10 @@ namespace XBMCAddon * * example: * - xbmcplugin.addSortMethod(int(sys.argv[1]), xbmcplugin.SORT_METHOD_TITLE) - * </pre> */ void addSortMethod(int handle, int sortMethod, const String& label2Mask = emptyString); /** - * <pre> * getSetting(handle, id) -- Returns the value of a setting as a string. * * handle : integer - handle the plugin was started with. @@ -133,12 +122,10 @@ namespace XBMCAddon * * example: * - apikey = xbmcplugin.getSetting(int(sys.argv[1]), 'apikey') - * </pre> */ String getSetting(int handle, const char* id); /** - * <pre> * setSetting(handle, id, value) -- Sets a plugin setting for the current running plugin. * * handle : integer - handle the plugin was started with. @@ -147,12 +134,10 @@ namespace XBMCAddon * * example: * - xbmcplugin.setSetting(int(sys.argv[1]), id='username', value='teamxbmc') - * </pre> */ void setSetting(int handle, const String& id, const String& value); /** - * <pre> * setContent(handle, content) -- Sets the plugins content. * * handle : integer - handle the plugin was started with. @@ -162,12 +147,10 @@ namespace XBMCAddon * * example: * - xbmcplugin.setContent(int(sys.argv[1]), 'movies') - * </pre> */ void setContent(int handle, const char* content); /** - * <pre> * setPluginCategory(handle, category) -- Sets the plugins name for skins to display. * * handle : integer - handle the plugin was started with. @@ -175,12 +158,10 @@ namespace XBMCAddon * * example: * - xbmcplugin.setPluginCategory(int(sys.argv[1]), 'Comedy') - * </pre> */ void setPluginCategory(int handle, const String& category); /** - * <pre> * setPluginFanart(handle, image, color1, color2, color3) -- Sets the plugins fanart and color for skins to display. * * handle : integer - handle the plugin was started with. @@ -191,7 +172,6 @@ namespace XBMCAddon * * example: * - xbmcplugin.setPluginFanart(int(sys.argv[1]), 'special://home/addons/plugins/video/Apple movie trailers II/fanart.png', color2='0xFFFF3300')\n - * </pre> */ void setPluginFanart(int handle, const char* image = NULL, const char* color1 = NULL, @@ -199,7 +179,6 @@ namespace XBMCAddon const char* color3 = NULL); /** - * <pre> * setProperty(handle, key, value) -- Sets a container property for this plugin. * * handle : integer - handle the plugin was started with. @@ -210,7 +189,6 @@ namespace XBMCAddon * * example: * - xbmcplugin.setProperty(int(sys.argv[1]), 'Emulator', 'M.A.M.E.')\n - * </pre> */ void setProperty(int handle, const char* key, const String& value); diff --git a/xbmc/interfaces/legacy/ModuleXbmcvfs.h b/xbmc/interfaces/legacy/ModuleXbmcvfs.h index b9d670c364..7327c7ae27 100644 --- a/xbmc/interfaces/legacy/ModuleXbmcvfs.h +++ b/xbmc/interfaces/legacy/ModuleXbmcvfs.h @@ -31,7 +31,6 @@ namespace XBMCAddon namespace xbmcvfs { /** - * <pre> * copy(source, destination) -- copy file to destination, returns true/false. * * source : file to copy. @@ -39,25 +38,21 @@ namespace XBMCAddon * * example: * success = xbmcvfs.copy(source, destination) - * </pre> */ bool copy(const String& strSource, const String& strDestnation); /** - * <pre> * delete(file) * * file : file to dele * * example: * xbmcvfs.delete(file) - * </pre> */ // delete a file bool deleteFile(const String& file); /** - * <pre> * rename(file, newFileName) * * file : file to reana @@ -65,71 +60,60 @@ namespace XBMCAddon * * example: * success = xbmcvfs.rename(file,newFileName) - * </pre> */ // rename a file bool rename(const String& file, const String& newFile); /** - * <pre> * exists(path) * * path : file or fold * * example: * success = xbmcvfs.exists(path) - * </pre> */ // check for a file or folder existance, mimics Pythons os.path.exists() bool exists(const String& path); /** - * <pre> * mkdir(path) -- Create a folder. * * path : folder * * example: * - success = xbmcvfs.mkdir(path) - * </pre> */ // make a directory bool mkdir(const String& path); /** - * <pre> * mkdirs(path) -- Create folder(s) - it will create all folders in the path. * * path : folder * * example: * - success = xbmcvfs.mkdirs(path) - * </pre> */ // make all directories along the path bool mkdirs(const String& path); /** - * <pre> * rmdir(path) -- Remove a folder. * * path : folder * * example: * - success = xbmcvfs.rmdir(path)\n - * </pre> */ bool rmdir(const String& path, bool force = false); /** - * <pre> * listdir(path) -- lists content of a folder. * * path : folder * * example: * - dirs, files = xbmcvfs.listdir(path) - * </pre> */ Tuple<std::vector<String>, std::vector<String> > listdir(const String& path); } diff --git a/xbmc/interfaces/legacy/Monitor.h b/xbmc/interfaces/legacy/Monitor.h index 77fbac7e5a..aafa281c77 100644 --- a/xbmc/interfaces/legacy/Monitor.h +++ b/xbmc/interfaces/legacy/Monitor.h @@ -29,11 +29,9 @@ namespace XBMCAddon namespace xbmc { /** - * <pre> * Monitor class. * * Monitor() -- Creates a new Monitor to notify addon about changes. - * </pre> */ class Monitor : public AddonCallback { @@ -50,49 +48,39 @@ namespace XBMCAddon #endif /** - * <pre> * onSettingsChanged() -- onSettingsChanged method. * * Will be called when addon settings are changed - * </pre> */ virtual void onSettingsChanged() { TRACE; } /** - * <pre> * onScreensaverActivated() -- onScreensaverActivated method. * * Will be called when screensaver kicks in - * </pre> */ virtual void onScreensaverActivated() { TRACE; } /** - * <pre> * onScreensaverDeactivated() -- onScreensaverDeactivated method. * * Will be called when screensaver goes off - * </pre> */ virtual void onScreensaverDeactivated() { TRACE; } /** - * <pre> * onDatabaseUpdated(database) -- onDatabaseUpdated method. * * database - video/music as stri * * Will be called when database gets updated and return video or music to indicate which DB has been changed - * </pre> */ virtual void onDatabaseUpdated(const String database) { TRACE; } /** - * <pre> * onAbortRequested() -- onAbortRequested method. * * Will be called when XBMC requests Abort - * </pre> */ virtual void onAbortRequested() { TRACE; } diff --git a/xbmc/interfaces/legacy/PlayList.h b/xbmc/interfaces/legacy/PlayList.h index 1b70c5a23b..e5dddb9dc6 100644 --- a/xbmc/interfaces/legacy/PlayList.h +++ b/xbmc/interfaces/legacy/PlayList.h @@ -46,7 +46,6 @@ namespace XBMCAddon inline int getPlayListId() const { return iPlayList; } /** - * <pre> * add(url[, listitem, index]) -- Adds a new file to the playlist. * * url : string or unicode - filename or url to add. @@ -62,68 +61,51 @@ namespace XBMCAddon * - listitem = xbmcgui.ListItem('Ironman', thumbnailImage='F:\\\\movies\\\\Ironman.tbn') * - listitem.setInfo('video', {'Title': 'Ironman', 'Genre': 'Science Fiction'}) * - playlist.add(url=video, listitem=listitem, index=7)\n - * </pre> */ void add(const String& url, XBMCAddon::xbmcgui::ListItem* listitem = NULL, int index = -1); /** - * <pre> * load(filename) -- Load a playlist. * * clear current playlist and copy items from the file to this Playlist * filename can be like .pls or .m3u ... * returns False if unable to load playlist - * </pre> */ bool load(const char* filename) throw (PlayListException); /** - * <pre> * remove(filename) -- remove an item with this filename from the playlist. - * </pre> */ void remove(const char* filename); /** - * <pre> * clear() -- clear all items in the playlist. - * </pre> */ void clear(); /** - * <pre> * size() -- returns the total number of PlayListItems in this playlist. - * </pre> */ int size(); /** - * <pre> * shuffle() -- shuffle the playlist. - * </pre> */ void shuffle(); /** - * <pre> * unshuffle() -- unshuffle the playlist. - * </pre> */ void unshuffle(); /** - * <pre> * getposition() -- returns the position of the current song in this playlist. - * </pre> */ int getposition(); /** - * <pre> * retrieve the item at the given position. A negative index means from the ending * rather than from the start. - * </pre> */ XBMCAddon::xbmcgui::ListItem* operator[](long i) throw (PlayListException); }; diff --git a/xbmc/interfaces/legacy/Player.h b/xbmc/interfaces/legacy/Player.h index 2aec620bb2..d06b0b11c6 100644 --- a/xbmc/interfaces/legacy/Player.h +++ b/xbmc/interfaces/legacy/Player.h @@ -41,7 +41,6 @@ namespace XBMCAddon XBMCCOMMONS_STANDARD_EXCEPTION(PlayerException); /** - * <pre> * Player class. * * Player([core]) -- Creates a new Player with as default the xbmc music playlist. @@ -56,7 +55,6 @@ namespace XBMCAddon * and xbmcmodule/PythonPlayer.h without the python references. The * queuing and handling of asynchronous callbacks is done internal to * this class. - * </pre> */ class Player : public AddonCallback, public IPlayerCallback { @@ -66,17 +64,14 @@ namespace XBMCAddon public: /** - * <pre> * 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. - * </pre> */ Player(int playerCore = EPC_NONE); virtual ~Player(void); /** - * <pre> * playStream([item, listitem, windowed]) -- Play this item. * * item : [opt] string - filename or url. @@ -93,12 +88,10 @@ namespace XBMCAddon * - listitem = xbmcgui.ListItem('Ironman') * - listitem.setInfo('video', {'Title': 'Ironman', 'Genre': 'Science Fiction'}) * - xbmc.Player( xbmc.PLAYER_CORE_MPLAYER ).play(url, listitem, windowed)\n - * </pre> */ void playStream(const String& item = emptyString, const XBMCAddon::xbmcgui::ListItem* listitem = NULL, bool windowed = false); /** - * <pre> * playPlaylist([playlist, windowed]) -- Play this item. * * playlist : [opt] playlist. @@ -111,119 +104,93 @@ namespace XBMCAddon * Once you use a keyword, all following arguments require the keyword. * * example: - * </pre> */ void playPlaylist(const PlayList* playlist = NULL, bool windowed = false); /** - * <pre> * play() -- try to play the current item in the current playlist. * * windowed : [opt] bool - true=play video windowed, false=play users preference.(default) * * example: * - xbmc.Player( xbmc.PLAYER_CORE_MPLAYER ).play() - * </pre> */ void playCurrent(bool windowed = false); /** - * <pre> * stop() -- Stop playing. - * </pre> */ void stop(); /** - * <pre> * pause() -- Pause playing. - * </pre> */ void pause(); /** - * <pre> * playnext() -- Play next item in playlist. - * </pre> */ void playnext(); /** - * <pre> * playprevious() -- Play previous item in playlist. - * </pre> */ void playprevious(); /** - * <pre> * playselected() -- Play a certain item from the current playlist. - * </pre> */ void playselected(int selected); /** - * <pre> * onPlayBackStarted() -- onPlayBackStarted method. * * Will be called when xbmc starts playing a file - * </pre> */ // Player_OnPlayBackStarted virtual void onPlayBackStarted(); /** - * <pre> * onPlayBackEnded() -- onPlayBackEnded method. * * Will be called when xbmc stops playing a file - * </pre> */ // Player_OnPlayBackEnded virtual void onPlayBackEnded(); /** - * <pre> * onPlayBackStopped() -- onPlayBackStopped method. * * Will be called when user stops xbmc playing a file - * </pre> */ // Player_OnPlayBackStopped virtual void onPlayBackStopped(); /** - * <pre> * onPlayBackPaused() -- onPlayBackPaused method. * * Will be called when user pauses a playing file - * </pre> */ // Player_OnPlayBackPaused virtual void onPlayBackPaused(); /** - * <pre> * onPlayBackResumed() -- onPlayBackResumed method. * * Will be called when user resumes a paused file - * </pre> */ // Player_OnPlayBackResumed virtual void onPlayBackResumed(); /** - * <pre> * onQueueNextItem() -- onQueueNextItem method. * * Will be called when user queues the next item - * </pre> */ virtual void onQueueNextItem(); /** - * <pre> * onPlayBackSpeedChanged(speed) -- onPlayBackSpeedChanged method. * * speed : integer - current speed of player. @@ -231,186 +198,149 @@ namespace XBMCAddon * *Note, negative speed means player is rewinding, 1 is normal playback speed. * * Will be called when players speed changes. (eg. user FF/RW) - * </pre> */ virtual void onPlayBackSpeedChanged(int speed); /** - * <pre> * onPlayBackSeek(time, seekOffset) -- onPlayBackSeek method. * * time : integer - time to seek to. * seekOffset : integer - ?. * * Will be called when user seeks to a time - * </pre> */ virtual void onPlayBackSeek(int time, int seekOffset); /** - * <pre> * onPlayBackSeekChapter(chapter) -- onPlayBackSeekChapter method. * * chapter : integer - chapter to seek to. * * Will be called when user performs a chapter seek - * </pre> */ virtual void onPlayBackSeekChapter(int chapter); /** - * <pre> * isPlaying() -- returns True is xbmc is playing a file. - * </pre> */ // Player_IsPlaying bool isPlaying(); /** - * <pre> * isPlayingAudio() -- returns True is xbmc is playing an audio file. - * </pre> */ // Player_IsPlayingAudio bool isPlayingAudio(); /** - * <pre> * isPlayingVideo() -- returns True if xbmc is playing a video. - * </pre> */ // Player_IsPlayingVideo bool isPlayingVideo(); /** - * <pre> * getPlayingFile() -- returns the current playing file as a string. * * Throws: Exception, if player is not playing a file. - * </pre> */ // Player_GetPlayingFile String getPlayingFile() throw (PlayerException); /** - * <pre> * getTime() -- Returns the current time of the current playing media as fractional seconds. * * Throws: Exception, if player is not playing a file. - * </pre> */ // Player_GetTime double getTime() throw(PlayerException); /** - * <pre> * seekTime() -- Seeks the specified amount of time as fractional seconds. * The time specified is relative to the beginning of the * currently playing media file. * * Throws: Exception, if player is not playing a file. - * </pre> */ // Player_SeekTime void seekTime(double seekTime) throw(PlayerException); /** - * <pre> * setSubtitles() -- set subtitle file and enable subtitles\n - * </pre> */ // Player_SetSubtitles void setSubtitles(const char* subtitleFile); // Player_ShowSubtitles /** - * <pre> * showSubtitles(visible) -- enable/disable subtitles * * visible : boolean - True for visible subtitles. * example: * - xbmc.Player().showSubtitles(True) - * </pre> */ void showSubtitles(bool bVisible); /** - * <pre> * getSubtitles() -- get subtitle stream name - * </pre> */ // Player_GetSubtitles String getSubtitles(); /** - * <pre> * DisableSubtitles() -- disable subtitles\n - * </pre> */ // Player_DisableSubtitles void disableSubtitles(); // Player_getAvailableSubtitleStreams /** - * <pre> * getAvailableSubtitleStreams() -- get Subtitle stream names - * </pre> */ std::vector<String>* getAvailableSubtitleStreams(); // Player_setSubtitleStream /** - * <pre> * setSubtitleStream(stream) -- set Subtitle Stream * * stream : int * * example: * - setSubtitleStream(1) - * </pre> */ void setSubtitleStream(int iStream); /** - * <pre> * getVideoInfoTag() -- returns the VideoInfoTag of the current playing Movie. * * Throws: Exception, if player is not playing a file or current file is not a movie file. - * </pre> */ InfoTagVideo* getVideoInfoTag() throw (PlayerException); /** - * <pre> * getMusicInfoTag() -- returns the MusicInfoTag of the current playing 'Song'. * * Throws: Exception, if player is not playing a file or current file is not a music file. - * </pre> */ // Player_GetMusicInfoTag InfoTagMusic* getMusicInfoTag() throw (PlayerException); /** - * <pre> *getTotalTime() -- Returns the total time of the current playing media in * seconds. This is only accurate to the full second. * *Throws: Exception, if player is not playing a file. - * </pre> */ double getTotalTime() throw (PlayerException); std::vector<String>* getAvailableAudioStreams(); /** - * <pre> * setAudioStream(stream) -- set Audio Stream * * stream : int * * example: * - setAudioStream(1) - * </pre> */ void setAudioStream(int iStream); diff --git a/xbmc/interfaces/legacy/RenderCapture.h b/xbmc/interfaces/legacy/RenderCapture.h index 76ec94c001..f5b81e3ef3 100644 --- a/xbmc/interfaces/legacy/RenderCapture.h +++ b/xbmc/interfaces/legacy/RenderCapture.h @@ -37,42 +37,32 @@ namespace XBMCAddon inline virtual ~RenderCapture() { g_renderManager.ReleaseRenderCapture(m_capture); } /** - * <pre> * getWidth() -- returns width of captured image. - * </pre> */ inline int getWidth() { return m_capture->GetWidth(); } /** - * <pre> * getHeight() -- returns height of captured image. - * </pre> */ inline int getHeight() { return m_capture->GetHeight(); } /** - * <pre> * getCaptureState() -- returns processing state of capture request. * * The returned value could be compared against the following constants: * xbmc.CAPTURE_STATE_WORKING : Capture request in progress. * xbmc.CAPTURE_STATE_DONE : Capture request done. The image could be retrieved with getImage() * xbmc.CAPTURE_STATE_FAILED : Capture request failed. - * </pre> */ inline int getCaptureState() { return m_capture->GetUserState(); } /** - * <pre> * getAspectRatio() -- returns aspect ratio of currently displayed video. - * </pre> */ inline float getAspectRatio() { return g_renderManager.GetAspectRatio(); } /** - * <pre> * getImageFormat() -- returns format of captured image: 'BGRA' or 'RGBA'. - * </pre> */ inline const char* getImageFormat() { @@ -85,11 +75,9 @@ namespace XBMCAddon // data. A memory buffer type. Then a typemap needs to be defined // for that type. /** - * <pre> * getImage() -- returns captured image as a bytearray. * * The size of the image is getWidth() * getHeight() * 4 - * </pre> */ // PyObject* RenderCapture_GetImage(RenderCapture *self, PyObject *args) // { @@ -104,7 +92,6 @@ namespace XBMCAddon // } /** - * <pre> * capture(width, height [, flags]) -- issue capture request. * * width : Width capture image should be rendered to @@ -114,7 +101,6 @@ namespace XBMCAddon * The value for 'flags' could be or'ed from the following constants: * xbmc.CAPTURE_FLAG_CONTINUOUS : after a capture is done, issue a new capture request immediately * xbmc.CAPTURE_FLAG_IMMEDIATELY : read out immediately when capture() is called, this can cause a busy wait - * </pre> */ inline void capture(int width, int height, int flags = 0) { @@ -122,13 +108,11 @@ namespace XBMCAddon } /** - * <pre> * waitForCaptureStateChangeEvent([msecs]) -- wait for capture state change event. * * msecs : Milliseconds to wait. Waits forever if not specified. * * The method will return 1 if the Event was triggered. Otherwise it will return 0. - * </pre> */ inline int waitForCaptureStateChangeEvent(unsigned int msecs = 0) { diff --git a/xbmc/interfaces/legacy/Stat.h b/xbmc/interfaces/legacy/Stat.h index 7818d33b37..d29294bc8c 100644 --- a/xbmc/interfaces/legacy/Stat.h +++ b/xbmc/interfaces/legacy/Stat.h @@ -30,7 +30,6 @@ namespace XBMCAddon namespace xbmcvfs { /** - * <pre> * Stat(path) -- Get file or file system status. * * path : file or folder @@ -38,7 +37,6 @@ namespace XBMCAddon * example: * st = xbmcvfs.Stat(path) * modified = st.st_mtime() - * </pre> */ class Stat : public AddonClass { diff --git a/xbmc/interfaces/legacy/Window.h b/xbmc/interfaces/legacy/Window.h index a365dc61ef..ccedb78ff2 100644 --- a/xbmc/interfaces/legacy/Window.h +++ b/xbmc/interfaces/legacy/Window.h @@ -71,10 +71,8 @@ namespace XBMCAddon }; /** - * <pre> * This is the main class for the xbmcgui.Window functionality. It is tied * into the main XBMC windowing system via the Interceptor - * </pre> */ class Window : public AddonCallback { @@ -106,36 +104,28 @@ namespace XBMCAddon virtual void deallocating(); /** - * <pre> * This helper retrieves the next available id. It is assumed * that the global lock is already being held. - * </pre> */ static int getNextAvailalbeWindowId() throw (WindowException); /** - * <pre> * Child classes MUST call this in their constructors. It should * be an instance of Interceptor<P extends CGUIWindow>. Control * of memory managment for this class is then given to the * Window - * </pre> */ void setWindow(InterceptorBase* _window); /** - * <pre> * This is a helper method since poping the * previous window id is a common function - * </pre> */ void popActiveWindowId(); /** - * <pre> * This is a helper method since getting * a control by it's id is a common function - * </pre> */ Control* GetControlById(int iControlId, CCriticalSection* gc) throw (WindowException); @@ -167,7 +157,6 @@ namespace XBMCAddon // callback takes a parameter /** - * <pre> * onAction(self, Action action) -- onAction method. * * This method will recieve all actions that the main program will send @@ -175,7 +164,6 @@ namespace XBMCAddon * By default, only the PREVIOUS_MENU and NAV_BACK actions are handled. * Overwrite this method to let your script handle all actions. * Don't forget to capture ACTION_PREVIOUS_MENU or ACTION_NAV_BACK, else the user can't close this window. - * </pre> */ virtual void onAction(Action* action); // on control is not actually on Window in the api but is called @@ -186,95 +174,76 @@ namespace XBMCAddon virtual void onInit(); /** - * <pre> * show(self) -- Show this window. * * Shows this window by activating it, calling close() after it wil activate the * current window again. * Note, if your script ends this window will be closed to. To show it forever, * make a loop at the end of your script ar use doModal() instead - * </pre> */ SWIGHIDDENVIRTUAL void show(); /** - * <pre> * setFocus(self, Control) -- Give the supplied control focus. * Throws: TypeError, if supplied argument is not a Control type * SystemError, on Internal error * RuntimeError, if control is not added to a window - * </pre> */ SWIGHIDDENVIRTUAL void setFocus(Control* pControl) throw (WindowException); /** - * <pre> * setFocusId(self, int) -- Gives the control with the supplied focus. * Throws: * SystemError, on Internal error * RuntimeError, if control is not added to a window - * </pre> */ SWIGHIDDENVIRTUAL void setFocusId(int iControlId); /** - * <pre> * getFocus(self, Control) -- returns the control which is focused. * Throws: SystemError, on Internal error * RuntimeError, if no control has focus - * </pre> */ SWIGHIDDENVIRTUAL Control* getFocus() throw (WindowException); /** - * <pre> * getFocusId(self, int) -- returns the id of the control which is focused. * Throws: SystemError, on Internal error * RuntimeError, if no control has focus - * </pre> */ SWIGHIDDENVIRTUAL long getFocusId() throw (WindowException); /** - * <pre> * removeControl(self, Control) -- Removes the control from this window. * * Throws: TypeError, if supplied argument is not a Control type * RuntimeError, if control is not added to this window * * This will not delete the control. It is only removed from the window. - * </pre> */ SWIGHIDDENVIRTUAL void removeControl(Control* pControl) throw (WindowException); /** - * <pre> * removeControls(self, List) -- Removes a list of controls from this window. * * Throws: TypeError, if supplied argument is not a Control type * RuntimeError, if control is not added to this window * * This will not delete the controls. They are only removed from the window. - * </pre> */ SWIGHIDDENVIRTUAL void removeControls(std::vector<Control*> pControls) throw (WindowException); /** - * <pre> * getHeight(self) -- Returns the height of this screen. - * </pre> */ SWIGHIDDENVIRTUAL long getHeight(); /** - * <pre> * getWidth(self) -- Returns the width of this screen. - * </pre> */ SWIGHIDDENVIRTUAL long getWidth(); /** - * <pre> * getResolution(self) -- Returns the resolution of the scree * The returned value is one of the following: * 0 - 1080i (1920x1080) @@ -287,12 +256,10 @@ namespace XBMCAddon * 7 - PAL 16:9 (720x576) * 8 - PAL60 4:3 (720x480) * 9 - PAL60 16:9 (720x480)\n - * </pre> */ SWIGHIDDENVIRTUAL long getResolution(); /** - * <pre> * setCoordinateResolution(self, int resolution) -- Sets the resolution * that the coordinates of all controls are defined in. Allows XBMC * to scale control positions and width/heights to whatever resolution @@ -308,12 +275,10 @@ namespace XBMCAddon * 7 - PAL 16:9 (720x576) * 8 - PAL60 4:3 (720x480) * 9 - PAL60 16:9 (720x480)\n - * </pre> */ SWIGHIDDENVIRTUAL void setCoordinateResolution(long res) throw (WindowException); /** - * <pre> * setProperty(key, value) -- Sets a window property, similar to an infolabel. * * key : string - property name. @@ -326,12 +291,10 @@ namespace XBMCAddon * example: * - win = xbmcgui.Window(xbmcgui.getCurrentWindowId()) * - win.setProperty('Category', 'Newest')\n - * </pre> */ SWIGHIDDENVIRTUAL void setProperty(const char* key, const String& value); /** - * <pre> * getProperty(key) -- Returns a window property as a string, similar to an infolabel. * * key : string - property name. @@ -343,12 +306,10 @@ namespace XBMCAddon * example: * - win = xbmcgui.Window(xbmcgui.getCurrentWindowId()) * - category = win.getProperty('Category') - * </pre> */ SWIGHIDDENVIRTUAL String getProperty(const char* key); /** - * <pre> * clearProperty(key) -- Clears the specific window property. * * key : string - property name. @@ -360,40 +321,32 @@ namespace XBMCAddon * example: * - win = xbmcgui.Window(xbmcgui.getCurrentWindowId()) * - win.clearProperty('Category')\n - * </pre> */ SWIGHIDDENVIRTUAL void clearProperty(const char* key); /** - * <pre> * clearProperties() -- Clears all window properties. * * example: * - win = xbmcgui.Window(xbmcgui.getCurrentWindowId()) * - win.clearProperties()\n - * </pre> */ SWIGHIDDENVIRTUAL void clearProperties(); /** - * <pre> * close(self) -- Closes this window. * * Closes this window by activating the old window. * The window is not deleted with this method. - * </pre> */ SWIGHIDDENVIRTUAL void close(); /** - * <pre> * doModal(self) -- Display this window until close() is called. - * </pre> */ SWIGHIDDENVIRTUAL void doModal(); /** - * <pre> * addControl(self, Control) -- Add a Control to this window. * * Throws: TypeError, if supplied argument is not a Control type @@ -412,23 +365,19 @@ namespace XBMCAddon * -ControlImage * -ControlRadioButton * -ControlProgress\n - * </pre> */ SWIGHIDDENVIRTUAL void addControl(Control* pControl) throw (WindowException); /** - * <pre> * addControls(self, List) -- Add a list of Controls to this window. * *Throws: TypeError, if supplied argument is not of List type, or a control is not of Control type * ReferenceError, if control is already used in another window * RuntimeError, should not happen :-) - * </pre> */ SWIGHIDDENVIRTUAL void addControls(std::vector<Control*> pControls) throw (WindowException); /** - * <pre> * getControl(self, int controlId) -- Get's the control from this window. * * Throws: Exception, if Control doesn't exist @@ -438,7 +387,6 @@ namespace XBMCAddon * * Note, not python controls are not completely usable yet * You can only use the Control functions - * </pre> */ SWIGHIDDENVIRTUAL Control* getControl(int iControlId) throw (WindowException); }; diff --git a/xbmc/interfaces/legacy/WindowXML.h b/xbmc/interfaces/legacy/WindowXML.h index beb35ae5f8..2bd31289de 100644 --- a/xbmc/interfaces/legacy/WindowXML.h +++ b/xbmc/interfaces/legacy/WindowXML.h @@ -51,10 +51,8 @@ namespace XBMCAddon protected: #ifndef SWIG /** - * <pre> * This helper retrieves the next available id. It is doesn't * assume that the global lock is already being held. - * </pre> */ static int lockingGetNextAvailalbeWindowId() throw (WindowException); @@ -118,7 +116,6 @@ namespace XBMCAddon }; /** - * <pre> * Ideally what we want here is a Dialog/Media Window. The problem is that these * are two orthogonal discriminations of CGUIWindow and there wasn't a previous * accounting for this possibility through the use of making CGUIWindow a @@ -132,7 +129,6 @@ namespace XBMCAddon * jmarshall says that this class has no reason to inherit from CGUIMediaWindow. * At some point this entire hierarchy needs to be reworked. The XML handling * routines should be put in a mixin. - * </pre> */ class WindowXMLDialog : public WindowXML, private WindowDialogMixin { |