Skip to content

Commit 96ad203

Browse files
committed
[builtins] 'PlayMedia' and 'QueueMedia': Improve docs to use markdown inline code statements instead of the double quotes.
1 parent 0aa2532 commit 96ad203

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

xbmc/interfaces/builtins/PlayerBuiltins.cpp

+15-15
Original file line numberDiff line numberDiff line change
@@ -794,16 +794,16 @@ static int SubtitleShiftDown(const std::vector<std::string>& params)
794794
/// <b>`PlayMedia(media[\,isdir][\,1]\,[playoffset=xx])`</b>
795795
/// ,
796796
/// Plays the given media. This can be a playlist\, music\, or video file\, directory\,
797-
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter "\,isdir" can
798-
/// be used for playing a directory. "\,1" will start the media without switching to fullscreen.
797+
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter `,isdir` can
798+
/// be used for playing a directory. `,1` will start the media without switching to fullscreen.
799799
/// If media is a playlist or a disc image stack or a video file stack\, you can use
800800
/// playoffset=xx where xx is the position to start playback from.
801801
/// @param[in] media URL to media to play (optional).
802-
/// @param[in] isdir Set "isdir" if media is a directory (optional).
803-
/// @param[in] windowed Set "1" to start playback without switching to fullscreen (optional).
804-
/// @param[in] resume Set "resume" to force resuming (optional).
805-
/// @param[in] noresume Set "noresume" to force not resuming (optional).
806-
/// @param[in] playoffset Set "playoffset=<offset>" to start playback from a given position in a playlist or stack (optional).
802+
/// @param[in] isdir Set `isdir` if media is a directory (optional).
803+
/// @param[in] windowed Set `1` to start playback without switching to fullscreen (optional).
804+
/// @param[in] resume Set `resume` to force resuming (optional).
805+
/// @param[in] noresume Set `noresume` to force not resuming (optional).
806+
/// @param[in] playoffset Set `playoffset=<offset>` to start playback from a given position in a playlist or stack (optional).
807807
/// }
808808
/// \table_row2_l{
809809
/// <b>`PlayWith(core)`</b>
@@ -822,18 +822,18 @@ static int SubtitleShiftDown(const std::vector<std::string>& params)
822822
/// <b>`QueueMedia(media[\,isdir][\,1][\,playnext]\,[playoffset=xx])`</b>
823823
/// \anchor Builtin_QueueMedia,
824824
/// Queues the given media. This can be a playlist\, music\, or video file\, directory\,
825-
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter "\,isdir" can
826-
/// be used for playing a directory. "\,1" will start the media without switching to fullscreen.
825+
/// plugin\, disc image stack\, video file stack or an URL. The optional parameter `,isdir` can
826+
/// be used for playing a directory. `,1` will start the media without switching to fullscreen.
827827
/// If media is a playlist or a disc image stack or a video file stack\, you can use
828828
/// playoffset=xx where xx is the position to start playback from.
829829
/// where xx is the position to start playback from.
830830
/// @param[in] media URL of media to queue.
831-
/// @param[in] isdir Set "isdir" if media is a directory (optional).
832-
/// @param[in] 1 Set "1" to start playback without switching to fullscreen (optional).
833-
/// @param[in] resume Set "resume" to force resuming (optional).
834-
/// @param[in] noresume Set "noresume" to force not resuming (optional).
835-
/// @param[in] playoffset Set "playoffset=<offset>" to start playback from a given position in a playlist or stack (optional).
836-
/// @param[in] playnext Set "playnext" to play the media right after the currently playing item, if player is currently
831+
/// @param[in] isdir Set `isdir` if media is a directory (optional).
832+
/// @param[in] 1 Set `1` to start playback without switching to fullscreen (optional).
833+
/// @param[in] resume Set `resume` to force resuming (optional).
834+
/// @param[in] noresume Set `noresume` to force not resuming (optional).
835+
/// @param[in] playoffset Set `playoffset=<offset>` to start playback from a given position in a playlist or stack (optional).
836+
/// @param[in] playnext Set `playnext` to play the media right after the currently playing item, if player is currently
837837
/// playing. If player is not playing, append media to current playlist (optional).
838838
/// <p><hr>
839839
/// @skinning_v20 **[New builtin]** \link Builtin_QueueMedia `QueueMedia(media[\,isdir][\,1][\,playnext]\,[playoffset=xx])`\endlink

0 commit comments

Comments
 (0)