Skip to content

Commit

Permalink
Merge pull request #25182 from DeltaMikeCharlie/docs-2024-05-addon
Browse files Browse the repository at this point in the history
[Docs] Fix unescaped commas for InfoLabel and Add-on Built-in Functions.
  • Loading branch information
ksooo committed May 10, 2024
2 parents 5b97125 + faf97d2 commit adad147
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions xbmc/GUIInfoManager.cpp
Expand Up @@ -3941,7 +3941,7 @@ const infomap musicplayer[] = {{ "title", MUSICPLAYER_TITLE },
/// \table_row3{ <b>`VideoPlayer.VideoVersionName`</b>,
/// \anchor VideoPlayer_VideoVersionName
/// _string_,
/// @return String containing the version name of the currently playing video (movie) - empty if not a movie, version name is not set or not a version
/// @return String containing the version name of the currently playing video (movie) - empty if not a movie\, version name is not set or not a version
/// <p><hr>
/// @skinning_v21 **[New Infolabel]** \link VideoPlayer_VideoVersionName `VideoPlayer.VideoVersionName`\endlink
/// }
Expand Down Expand Up @@ -6488,7 +6488,7 @@ const infomap container_str[] = {{ "property", CONTAINER_PROPERTY },
/// _string_,
/// @return From addon defined message text when it is marked as special condition inside repository.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link ListItem_AddonLifecycleDesc `ListItem.AddonLifecycleDesc``\endlink
/// @skinning_v19 **[New Infolabel]** \link ListItem_AddonLifecycleDesc `ListItem.AddonLifecycleDesc`\endlink
/// replaces `ListItem.AddonBroken`.
/// <p>
/// }
Expand Down Expand Up @@ -6910,7 +6910,7 @@ const infomap container_str[] = {{ "property", CONTAINER_PROPERTY },
/// \table_row3{ <b>`ListItem.AlbumStatus`</b>,
/// \anchor ListItem_AlbumStatus
/// _string_,
/// @return The Musicbrainz release status of the album (official, bootleg, promotion etc)
/// @return The Musicbrainz release status of the album (official\, bootleg\, promotion etc)
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link ListItem_AlbumStatus `ListItem.AlbumStatus`\endlink
/// }
Expand Down
16 changes: 8 additions & 8 deletions xbmc/interfaces/builtins/PlayerBuiltins.cpp
Expand Up @@ -771,8 +771,8 @@ static int SubtitleShiftDown(const std::vector<std::string>& params)
/// | Partymode(path to .xsp) | Partymode for *.xsp-file | Partymode for *.xsp-file | |
/// | ShowVideoMenu | Shows the DVD/BR menu if available | none | |
/// | FrameAdvance(n) *** | Advance video by _n_ frames | none | Kodi v18 |
/// | SubtitleShiftUp(save) | Shift up the subtitle position, add "save" to save the change permanently | none | Kodi v20 |
/// | SubtitleShiftDown(save) | Shift down the subtitle position, add "save" to save the change permanently | none | Kodi v20 |
/// | SubtitleShiftUp(save) | Shift up the subtitle position\, add "save" to save the change permanently | none | Kodi v20 |
/// | SubtitleShiftDown(save) | Shift down the subtitle position\, add "save" to save the change permanently | none | Kodi v20 |
/// <br>
/// '*' = For these controls\, the PlayerControl built-in function can make use of the 'notify'-parameter. For example: PlayerControl(random\, notify)
/// <br>
Expand Down Expand Up @@ -803,8 +803,8 @@ static int SubtitleShiftDown(const std::vector<std::string>& params)
/// <b>`PlayMedia(media[\,isdir][\,1]\,[playoffset=xx])`</b>
/// ,
/// Plays the given media. This can be a playlist\, music\, or video file\, directory\,
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter `,isdir` can
/// be used for playing a directory. `,1` will start the media without switching to fullscreen.
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter `\,isdir` can
/// be used for playing a directory. `\,1` will start the media without switching to fullscreen.
/// If media is a playlist or a disc image stack or a video file stack\, you can use
/// playoffset=xx where xx is the position to start playback from.
/// @param[in] media URL to media to play (optional).
Expand All @@ -831,8 +831,8 @@ static int SubtitleShiftDown(const std::vector<std::string>& params)
/// <b>`QueueMedia(media[\,isdir][\,1][\,playnext]\,[playoffset=xx])`</b>
/// \anchor Builtin_QueueMedia,
/// Queues the given media. This can be a playlist\, music\, or video file\, directory\,
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter `,isdir` can
/// be used for playing a directory. `,1` will start the media without switching to fullscreen.
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter `\,isdir` can
/// be used for playing a directory. `\,1` will start the media without switching to fullscreen.
/// If media is a playlist or a disc image stack or a video file stack\, you can use
/// playoffset=xx where xx is the position to start playback from.
/// where xx is the position to start playback from.
Expand All @@ -842,8 +842,8 @@ static int SubtitleShiftDown(const std::vector<std::string>& params)
/// @param[in] resume Set `resume` to force resuming (optional).
/// @param[in] noresume Set `noresume` to force not resuming (optional).
/// @param[in] playoffset Set `playoffset=<offset>` to start playback from a given position in a playlist or stack (optional).
/// @param[in] playnext Set `playnext` to play the media right after the currently playing item, if player is currently
/// playing. If player is not playing, append media to current playlist (optional).
/// @param[in] playnext Set `playnext` to play the media right after the currently playing item\, if player is currently
/// playing. If player is not playing\, append media to current playlist (optional).
/// <p><hr>
/// @skinning_v20 **[New builtin]** \link Builtin_QueueMedia `QueueMedia(media[\,isdir][\,1][\,playnext]\,[playoffset=xx])`\endlink
/// <p>
Expand Down

0 comments on commit adad147

Please sign in to comment.