control4 / docs-driverworks

Home Page for the Driverworks SDK
Other
41 stars 17 forks source link

ntoh / htoh sections wrong #11

Open spike411 opened 3 years ago

spike411 commented 3 years ago

https://control4.github.io/docs-driverworks-api/#ntoh-1

ntoh 1 Function called from DriverWorks driver to get a capability from the driver’s .c4z file. This API should not be invoked during OnDriverInit.

The example also shows the GetCapability functions.

https://control4.github.io/docs-driverworks-api/#htoh-2

The title says htoh 2, the signature says C4:htoh_1(), the example shows nbo = C4:ntoh_l(0x34120000).

Does htoh (host to host) even make any sense?

I also had to read the whole description to figure out that 'h' means 'host' (I guessed that 'n' means 'network' because it's mentioned at the beginning).

Maybe it would be nice to spell out 'network to host' and 'host to network' somewhere at the beginning of the functions' respective descriptions.