Skip to content

Commit

Permalink
Merge pull request #4556 from MartijnKaijser/pydoc_fix1
Browse files Browse the repository at this point in the history
[pydocs] fix pydocs line ending and add additional information regarding...
  • Loading branch information
t-nelson committed Apr 15, 2014
2 parents e559003 + bba0289 commit a4e7935
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions xbmc/interfaces/legacy/Dialog.h
Expand Up @@ -66,6 +66,7 @@ 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
* \n
* example:\n
* - dialog = xbmcgui.Dialog()\n
Expand Down Expand Up @@ -102,6 +103,7 @@ namespace XBMCAddon
* 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
* \n
* example:\n
* - dialog = xbmcgui.Dialog()\n
Expand Down Expand Up @@ -310,6 +312,7 @@ namespace XBMCAddon
* 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, Use update() to update lines and progressbar.\n
* \n
* example:
Expand All @@ -321,13 +324,14 @@ namespace XBMCAddon
const String& line3 = emptyString) throw (WindowException);

/**
* update(percent[, line1, line2, line3]) -- Update's the progress dialog.\n
* 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
* 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, If percent == 0, the progressbar will be hidden.\n
* \n
* example:
Expand Down Expand Up @@ -373,13 +377,13 @@ namespace XBMCAddon


/**
* create(heading[, message]) -- Create and show a background progress dialog.n\n
* create(heading[, message]) -- Create and show a background progress dialog.\n
*
* heading : string or unicode - dialog headingn\n
* message : [opt] string or unicode - message textn\n
* heading : string or unicode - dialog heading.\n
* message : [opt] string or unicode - message text.\n
*
* *Note, 'heading' is used for the dialog's id. Use a unique heading.n\n
* Use update() to update heading, message and progressbar.n\n
* *Note, 'heading' is used for the dialog's id. Use a unique heading.\n
* Use update() to update heading, message and progressbar.\n
*
* example:
* - pDialog = xbmcgui.DialogProgressBG()
Expand All @@ -391,8 +395,8 @@ namespace XBMCAddon
* update([percent, heading, message]) -- Updates the background progress dialog.
*
* percent : [opt] integer - percent complete. (0:100)\n
* heading : [opt] string or unicode - dialog heading\n
* message : [opt] string or unicode - message text\n
* heading : [opt] string or unicode - dialog heading.\n
* message : [opt] string or unicode - message text.\n
*
* *Note, To clear heading or message, you must pass a blank character.\n
*
Expand Down

0 comments on commit a4e7935

Please sign in to comment.