Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add missing Player infolabels/boolean conditions #14261

Merged
merged 2 commits into from Aug 11, 2018

Conversation

enen92
Copy link
Member

@enen92 enen92 commented Aug 3, 2018

Description

Adds missing player infolabels/boolean conditions docs, namely:

  • Player.HasGame
  • Player.TempoEnabled
  • Player.IsTempo
  • Player.PlaySpeed
  • Player.HasResolutions
  • Player.HasPrograms

Motivation and Context

Have complete docs. Those labels/bools are exposed to python and skins so an effort to clearly state what they do in simple terms is important.
The ultimate goal is to deprecate the respective wiki page as it is tremendously outdated. In follow up PR's I'll continue to track missing doc entries, complement with important info that may be present in the wiki and add information regarding which Kodi version a particular infolabel/bool was introduced.

How Has This Been Tested?

compiled docs

Pings:
@FernetMenta, @peak3d, @spiff

Types of change

  • Bug fix (non-breaking change which fixes an issue)
  • Clean up (non-breaking change which removes non-working, unmaintained functionality)
  • Improvement (non-breaking change which improves existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that will cause existing functionality to change)
  • Cosmetic change (non-breaking change that doesn't touch code)
  • None of the above (please explain below)

Checklist:

  • My code follows the Code Guidelines of this project
  • My change requires a change to the documentation, either Doxygen or wiki
  • I have updated the documentation accordingly
  • I have read the Contributing document
  • I have added tests to cover my change
  • All new and existing tests passed

@enen92 enen92 added Type: Improvement non-breaking change which improves existing functionality Documentation v18 Leia No Jenkins do not run automatic Jenkins builds on this PR labels Aug 3, 2018
/// \table_row3{ <b>`Player.PlaySpeed`</b>,
/// \anchor Player_PlaySpeed
/// _string_,
/// Returns the player playback speed (tempo) with the format %1.2f (1.00 means normal playback speed)

This comment was marked as spam.

This comment was marked as spam.

/// \table_row3{ <b>`Player.HasPrograms`</b>,
/// \anchor Player_HasPrograms
/// _boolean_,
/// Returns true if the media file being played has programs\, i.e. groups of streams.

This comment was marked as spam.

@enen92 enen92 force-pushed the doxygenplayerinfolabels branch 2 times, most recently from 3a08861 to e8d2d96 Compare August 3, 2018 20:16
@da-anda da-anda changed the title [docs] Add missing missing Player infolabels/boolean conditions [docs] Add missing Player infolabels/boolean conditions Aug 9, 2018
/// \table_row3{ <b>`Player.PlaySpeed`</b>,
/// \anchor Player_PlaySpeed
/// _string_,
/// Returns the player playback speed (tempo) with the format %1.2f (1.00 means normal

This comment was marked as spam.

@enen92
Copy link
Member Author

enen92 commented Aug 10, 2018

@FernetMenta fixed, thanks 👍

@DaVukovic
Copy link
Member

probably a bit of nitpicking ;)

at line 388:

const infomap player_labels[] = {{ "hasmedia", PLAYER_HAS_MEDIA }, // bools from here

and at line 409:

{ "cachelevel", PLAYER_CACHELEVEL }, // labels from here

There are comments //bools from here and //labels from here. Some of the bools you documented are placed below that line and should probably placed above.

Same counts for Player.Title which doesn´t return a boolean but a string instead and therefore is a label. So that should be placed somewhere below line 409.

probably take a look:
DaVukovic@a525b45

I didn´t PRd that as I saw you are working on the same file ;). Feel free to pick that as well ;)

@enen92
Copy link
Member Author

enen92 commented Aug 10, 2018

Thanks @DaVukovic, cherry-picked your commit

@FernetMenta
Copy link
Contributor

Thanks!

@MartijnKaijser MartijnKaijser added this to the Leia 18.0-beta1 milestone Aug 11, 2018
@MartijnKaijser MartijnKaijser merged commit 2d304b5 into xbmc:master Aug 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation No Jenkins do not run automatic Jenkins builds on this PR Type: Improvement non-breaking change which improves existing functionality v18 Leia
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants