OpenEuphoria

Re: Style idea for writing code that turns into documentation

• Posted by petelomax Jun 15, 2015
• 1337 views

      --> atom : True (!0) if checked, False (0) if not checked 

That alone would slowly drive me nuts

    public function   --> atom : True (!0) if checked, False (0) if not checked 
        IsChecked  
        (  
        atom handle -- is the handle of the checkbox, radio or pushbutton widget to verify 
        ) 

And having to read code like that even more so. Anyway, would not the following be better final documentation, and just as easy to achieve?

IsChecked(atom handle)

handle is the id of a checkbox, radio or pushbutton widget

Returns True if the specified control is currently checked or depressed.

See Also:

| Checkbox | Radio | Pushbutton |