Update Developer docs from 24.lts branch #2984

sideb0ard · 2024-04-17T22:37:24Z

Publish updated dev docs.

This CL replaces #2909 which was run from trunk, and wasn't formatted correctly.

b/333721484

oxve · 2024-04-17T23:14:44Z

cobalt/site/docs/reference/starboard/modules/13/decode_target.md

@@ -11,17 +11,15 @@ An SbDecodeTarget can be passed into any function which decodes video or image
 data. This allows the application to allocate fast graphics memory, and have
 decoding done directly into this memory, avoiding unnecessary memory copies, and
 also avoiding pushing data between CPU and GPU memory unnecessarily.
-
-## SbDecodeTargetFormat


These don't look right to me. The header markers are removed which will make the headers appear as regular text and also removes the extra newline which (due to markdown) make the text appear on the same row as the text above.

Do you know of any changes in the corresponding C++ file that would cause this?

Same for the similarly removed header markers below.

Judging by the amount of changes, it seems like these haven't been generated in a while, so likely many c++ changes. The only one I made was in, which is what my aim is to update:
#2905

then this PR is all generated from two commands:

docker run -it --mount type=bind,source=$(pwd),target=/code docsite
pre-commit run

oxve · 2024-04-17T23:15:41Z

cobalt/site/docs/reference/starboard/modules/13/ui_navigation.md

@@ -268,6 +268,7 @@ right and top-to-bottom.
 ```
  Top-to-bottom is similar to left-to-right, but for the Y position.
  Bottom-to-top is similar to right-to-left, but for the Y position.
+


This also looks a little funky to me.

can you re-test the devsite generation instructions and see if see if you get the same results?

oxve · 2024-04-17T23:17:15Z

cobalt/site/docs/reference/starboard/modules/14/media.md

@@ -452,7 +452,7 @@ return `kSbMediaSupportTypeProbably` kSbMediaSupportTypeProbably when
 `key_system` is `com.widevine.alpha; invalid_attribute="invalid_value"`.
 Currently the only attribute has to be supported is `encryptionscheme`. It
 reflects the value passed to `encryptionScheme` encryptionScheme of
-MediaKeySystemMediaCapability, as defined in [https://wicg.github.io/encrypted-media-encryption-scheme/,](https://wicg.github.io/encrypted-media-encryption-scheme/,),) which can take value "cenc", "cbcs", or "cbcs-1-9". Empty string is
+MediaKeySystemMediaCapability, as defined in [https://wicg.github.io/encrypted-media-encryption-scheme/](https://wicg.github.io/encrypted-media-encryption-scheme/)/) , which can take value "cenc", "cbcs", or "cbcs-1-9". Empty string is


This doesn't look correct. There's an /) at the end.

oxve · 2024-04-17T23:18:48Z

cobalt/site/docs/reference/starboard/modules/13/condition_variable.md

@@ -138,4 +138,3 @@ result.
 ```
 SbConditionVariableResult SbConditionVariableWaitTimed(SbConditionVariable *condition, SbMutex *mutex, SbTime timeout_duration)
 ```
-


This trailing newline should probably stay. Did pre-commit allow this?

oxve · 2024-04-17T23:24:32Z

cobalt/site/docs/reference/starboard/modules/15/media.md

@@ -466,7 +466,7 @@ return `kSbMediaSupportTypeProbably` kSbMediaSupportTypeProbably when
 `key_system` is `com.widevine.alpha; invalid_attribute="invalid_value"`.
 Currently the only attribute has to be supported is `encryptionscheme`. It
 reflects the value passed to `encryptionScheme` encryptionScheme of
-MediaKeySystemMediaCapability, as defined in [https://wicg.github.io/encrypted-media-encryption-scheme/,](https://wicg.github.io/encrypted-media-encryption-scheme/,),) which can take value "cenc", "cbcs", or "cbcs-1-9". Empty string is
+MediaKeySystemMediaCapability, as defined in [https://wicg.github.io/encrypted-media-encryption-scheme/](https://wicg.github.io/encrypted-media-encryption-scheme/)/) , which can take value "cenc", "cbcs", or "cbcs-1-9". Empty string is


Another extra /) here too.

oxve · 2024-04-17T23:24:54Z

cobalt/site/docs/reference/starboard/modules/condition_variable.md

@@ -138,4 +138,3 @@ result.
 ```
 SbConditionVariableResult SbConditionVariableWaitTimed(SbConditionVariable *condition, SbMutex *mutex, SbTime timeout_duration)
 ```
-


Another trailing newline that's removed.

oxve · 2024-04-17T23:25:10Z

cobalt/site/docs/reference/starboard/modules/media.md

@@ -466,7 +466,7 @@ return `kSbMediaSupportTypeProbably` kSbMediaSupportTypeProbably when
 `key_system` is `com.widevine.alpha; invalid_attribute="invalid_value"`.
 Currently the only attribute has to be supported is `encryptionscheme`. It
 reflects the value passed to `encryptionScheme` encryptionScheme of
-MediaKeySystemMediaCapability, as defined in [https://wicg.github.io/encrypted-media-encryption-scheme/,](https://wicg.github.io/encrypted-media-encryption-scheme/,),) which can take value "cenc", "cbcs", or "cbcs-1-9". Empty string is
+MediaKeySystemMediaCapability, as defined in [https://wicg.github.io/encrypted-media-encryption-scheme/](https://wicg.github.io/encrypted-media-encryption-scheme/)/) , which can take value "cenc", "cbcs", or "cbcs-1-9". Empty string is


/) here too.

xiaomings · 2024-04-17T23:42:14Z

cobalt/site/docs/reference/starboard/modules/player.md

@@ -449,6 +551,24 @@ Returns whether the given player handle is valid.
 static bool SbPlayerIsValid(SbPlayer player)
 ```

+### SbPlayerSeek
+
+`seek_to_timestamp`: The frame at which playback should begin. `ticket`: A user-


ticket should probably be put on a new line.

xiaomings · 2024-04-17T23:43:31Z

cobalt/site/docs/reference/starboard/modules/player.md

+### SbPlayerSeek
+
+`seek_to_timestamp`: The frame at which playback should begin. `ticket`: A user-
+supplied unique ID that is be passed to all subsequent


"that is be" => "to be"

In general the comment of the function should be refined. Please sync with @borongc to who's working on it to prioritize this.

The PR (#2958) is in progress, will modify player.h later.

This PR updates the description in drm.h, decode_target.h, media.h, and player.h. This also fixes formatting issues in PR #2984. b/326450058

This PR updates the description in drm.h, decode_target.h, media.h, and player.h. This also fixes formatting issues in PR #2984. b/326450058 (cherry picked from commit 80a62f0)

Refer to the original PR: #2958 This PR updates the description in drm.h, decode_target.h, media.h, and player.h. This also fixes formatting issues in PR #2984. b/326450058 Co-authored-by: Bo-Rong Chen <[email protected]>

borongc · 2024-05-08T17:54:50Z

The PR (#3193) is merged to 25.lts.1+, and I keep another PR (#3192) to 24.lts.1+ open, if we want to merge it to 24.lts.1+.

Updating Developer docs from 24.lts branch

b7e3387

sideb0ard requested review from oxve, kaidokert and xiaomings April 17, 2024 22:37

sideb0ard mentioned this pull request Apr 17, 2024

Update developer docs #2909

Closed

oxve reviewed Apr 17, 2024

View reviewed changes

xiaomings reviewed Apr 17, 2024

View reviewed changes

borongc mentioned this pull request Apr 18, 2024

Update Starboard media header description #2958

Merged

borongc added a commit that referenced this pull request May 8, 2024

Update Starboard media header description (#2958)

80a62f0

This PR updates the description in drm.h, decode_target.h, media.h, and player.h. This also fixes formatting issues in PR #2984. b/326450058

cobalt-github-releaser-bot mentioned this pull request May 8, 2024

Cherry pick PR #2958: Update Starboard media header description #3192

Closed

cobalt-github-releaser-bot mentioned this pull request May 8, 2024

Cherry pick PR #2958: Update Starboard media header description #3193

Merged

sideb0ard closed this Jan 13, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Developer docs from 24.lts branch #2984

Update Developer docs from 24.lts branch #2984

sideb0ard commented Apr 17, 2024

oxve Apr 17, 2024

sideb0ard Apr 18, 2024

oxve Apr 17, 2024

sideb0ard Apr 18, 2024

oxve Apr 17, 2024

oxve Apr 17, 2024

oxve Apr 17, 2024

oxve Apr 17, 2024

oxve Apr 17, 2024

xiaomings Apr 17, 2024

xiaomings Apr 17, 2024

borongc Apr 18, 2024

borongc commented May 8, 2024

Update Developer docs from 24.lts branch #2984

Update Developer docs from 24.lts branch #2984

Conversation

sideb0ard commented Apr 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borongc commented May 8, 2024