SDK documentation: links to fix, missing/broken/etc

Starting this thread to enumerate issues in the docs that have to be fixed. There is a bunch of these suckers, which is annoyance but more importantly stops in their tracks novices, who are not used to such quirks (example). So let’s list them here so they will be fixed… “inshallah”.

I’ll start with

  • much rejoicing: Screensaver documentation is apparently M.I.A., needs to be added to wiki. See viewtopic.php?f=34&t=69276#p439457

  • fixed: roChannelStore, ifGetMessagePort/ifSetMessagePort links are broken

  • fixed roTextureManager does not list “Supported Events” (compare). It has associated port (if?etMessagePort) and should point to what it may get. There is at least one event it gets, roTextureRequestEvent - it should be linked from that page.

  • ifMessageDialog fails to mention which methods are not available in fw3. For details, see viewtopic.php?f=34&t=69825#p441250 [Would be nice if the documentation mentioned this but Firmware 3.x is deprecated so probably this will not happen - RokuJoel]

  • Does roTextureManager really maintain LRU cache of resources, flushing the old ones as not to run out of memory (if so should be documented!) - or is it an urban legend? See viewtopic.php?f=34&t=69730#p441106

  • fixed Nov’14 roOneLineDialogEvent info seems to mislead on support for buttons, see viewtopic.php?f=34&t=69839

  • ifListScreen apparently does not support SetBreadcrumbText() in fw3, document it; viewtopic.php?f=34&t=69948
    [Again, unlikely that we will address this as fw 3.x is deprecated - RokuJoel]

Please add further your discoveries.

Fixed
The Language Reference, section 5.11: IF expression THEN statements [ELSE statements]

“If caveman = “fred” then print “flintsone” else print “rubble””

Flintstone is misspelled!

While we’re worrying about details like billing and function description errors and sample program failures, we almost missed something really important like this.

FR missing as possible Country Code (Channel Store region).

Super minor issue but for the perfectionists;

https://sdkdocs.roku.com/display/sdkdoc … LComponent

Similarly H is set to 4 because the item is 4 columns tall.

Should be “rows”

Similar, https://sdkdocs.roku.com/display/sdkdoc/MarkupList

Note that the actual number of rows may be more or less than the number of visible columns depending on the number of items in the grid’s content.

“columns” should be “rows”.
Should it be “grid” or “list” - Maybe “grid” was intended since the MarkupList extends ArrayGrid?

https://sdkdocs.roku.com/display/sdkdoc … elSetScene
The OverhangPanelSetSc****ene node class provides a convenient was
should be “way”

Also, would it be possible to add “next” and “prev” links at the bottom of the sdkdocs as an alternative to clicking the left menu?

Example XML lacks the component it’s supposed to be an example of: https’ target=‘_blank’>https://sdkdocs.roku.com/display/sdkdoc/MarkupGrid

You can some of the same fields
typo here
https://sdkdocs.roku.com/display/sdkdoc … ListMarkup

(I don’t “can” any fields, tomatoes sometimes, but fields? no.)

On https://blog.roku.com/developer/2016/03 … -tutorial/
under Sthree resources, the link is broken to

  • SceneGraph XML Guide[/url:1f9rpchx]

On this page https://sdkdocs.roku.com/display/sdkdoc/Button
are incorrect default values for iconUri, focusedIconUri

ref: https://forums.roku.com/viewtopic.php?f … 80#p564280

Additionally, for Button if using an image with a size larger than maxwidth, if minWidth is not set, seems it’s defaulting to the width of the image and therefore minwidth must be set to decrease the size. (what I would expect maxwidth to do)
if I set maxwidth only (and no minwidth), the button is much wider than the maxwidth value. if set minwidth only (and no maxwidth), the button is the width of minwidth. seems something’s mixed up here, or is it just me?
thanks

https://sdkdocs.roku.com/display/sdkdoc … terpolator
Seems to me the description (Use) for fieldToInterp is wrong, says should be separated by colon but that doesn’t work (for me on Roku 3, targetting opacity), needs to be separated by a dot;

separated by a colon. For example, “title:width” <---- what’s there now

separated by a dot. For example, “title.width” <---- what it should probably be

(PS. rNB: fixed)

Broken link from here https://sdkdocs.roku.com/display/sdkdoc/roSGNode
Reference information on all Scene Graph node classes can be found in this Scene Graph Reference[/url:3sg3x7mk].

https://sdkdocs.roku.com/display/sdkdoc/Label
lineSpacing - default is reported as 0
however, testing this, it’s not 0.
The default looks to be something like 10.

https://sdkdocs.roku.com/display/sdkdoc … lAlignment
It seems like the instructions about height are wrong, assuming the Label’s height field should automatically update once the text is set?

Request: Please expose the “computed height” of the label after text update?

Duplicate field
showRowCounterForShortRows is listed twice in the field column on https://sdkdocs.roku.com/display/sdkdoc/RowList

The link to openSSL is broken on this page; http://www.openssl.org/docs/crypto/hmac.html that redirects to “Page not found”
I haven’t yet found if there is a suitable replacement… searching…

Also on this same page https://sdkdocs.roku.com/display/sdkdoc/roHMAC I think it would be nice to elucidate the functions getkey() and getMessage() to show the user that these are not built in functions and they need to return a string of their own design.

thank you :slightly_smiling_face:

on this page : https://developer.roku.com/develop/mone … tion-index
the link Roku Billing and In-Channel Purchasing. is broken

Seems like there should be a “documentation” link from here: https://sdkdocs.roku.com/display/sdkdoc/BrightScript+Profiler

wondering why this is wrong; https://sdkdocs.roku.com/display/sdkdoc … pt+Support

roRegistry    Can only be used in a Task node
roRegistrySection    Can only be used in a Task node

Is it OK practice to continue accessing the registry from the render thread?