Prop' IDE documentation error

simonl

Just noticed that the documentation view doesn't display·a PRI properly, it just displays any of its documentation comments in with the previous PUB's comments. Example:

PUB· main
· Start display device
· Start memsic 2125
· Mainloop - captures and displays sensor readings
· Capture all measurements·
· Display all measurements
· Pause to allow things to settle
· TV_WText standard characters

I believe this should be:

PUB· main
· Start display device
· Start memsic 2125
· Mainloop - captures and displays sensor readings
· Capture all measurements·
· Display all measurements
PRI settle
··Pause to allow things to settle
CON
··TV_WText standard characters


▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
Cheers,

Simon

Paul Baker

As is oft' said, thats not a bug it's a design feature. All kidding aside, the documentation mode is designed as a quick user guide for the object. Since PRI functions are not accessible to an end user of the object, these are not included in the documentation. However any text which you designate as documentation using '' or {{...}} is included in the documentation. My advice to make the most readable documentation, use the documentation notation for public functions, but use the comment notation (' or {...}) for private functions.

▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
Paul Baker
Propeller Applications Engineer

Parallax, Inc.

simonl

Ah, yup, I see what you mean -- I was thinking from the object's developer standpoint -- your suggestion works for me

▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
Cheers,

Simon