Why is the documentation and adjusting of the TV-object so cryptic ??
StefanL38
Posts: 2,292
hello,
I took a look into the TV-object
My Opinion: the documentation of the object is very cryptic and small.
How about creating a set of constants that are easy to combine to
make it easy to setup the object to the various modes of operation
I mean it this way
etc. etc.
so that the mode could be setup by simply ORing the constants ?
The NAME of the constants should have a part which guides to the right long where it has to be stored
As it is a READY-TO-USE-Object it should have a documentation that makes the setup as simple as the one for
FullDuplexSerial
call a start-method with a set of parameters
The tv-driver is more complex and has much more modes
but then it is much more important to add documentation that
explains how things work
best regards
Stefan
Post Edited (StefanL38) : 12/9/2008 9:51:06 PM GMT
I took a look into the TV-object
My Opinion: the documentation of the object is very cryptic and small.
How about creating a set of constants that are easy to combine to
make it easy to setup the object to the various modes of operation
I mean it this way
CON 'pingroupselection Pin_Group_Selection7_0 = 0 Pin_Group_Selection15_8 = %00010000 'pingroup 6..4 001 Pin_Group_Selection23_16 = %00100000 'pingroup 6..4 010
etc. etc.
so that the mode could be setup by simply ORing the constants ?
The NAME of the constants should have a part which guides to the right long where it has to be stored
As it is a READY-TO-USE-Object it should have a documentation that makes the setup as simple as the one for
FullDuplexSerial
call a start-method with a set of parameters
The tv-driver is more complex and has much more modes
but then it is much more important to add documentation that
explains how things work
best regards
Stefan
Post Edited (StefanL38) : 12/9/2008 9:51:06 PM GMT
Comments
Go for it!
-tom
You bring up an interesting point about the TV object. The code isn't cryptic for obfuscation purposes, though, but to keep it as compact and feature-rich as possible. Nonetheless, your proposed use of constants to make configuration easier and more intuituve seems well-founded, and I would encourage you to pursue it. I might suggest more compact names for them, however, for the sake of readability.
Also, please realize that the Propeller Object Exchange is open for all to add to. Your proposed improvements seem very helpful and would certainly be a welcome addition to the Exchange, should you choose to contribute them.
-Phil
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
'Just a few PropSTICK Kit bare PCBs left!