02.03.2014 Views

Tornado

Tornado

Tornado

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

<strong>Tornado</strong> 2.0<br />

User’s Guide<br />

■<br />

Errors: The word ERRORS: followed by all the error messages or error code<br />

(or both, if necessary) raised in the procedure by the Tcl error command.<br />

ERRORS:<br />

"Cannot find symbol in symbol table"<br />

If no error statement is invoked in the procedure, enter N/A.<br />

ERRORS: N/A<br />

The procedure documentation ends with an empty Tcl comment starting in<br />

column one.<br />

The procedure declaration follows the procedure heading and is separated from<br />

the documentation block by a single blank line. The format of the procedure and<br />

parameter declarations is shown in VxWorks Programmer’s Guide: Coding<br />

Conventions.<br />

The following is an example of a standard procedure layout.<br />

Example B-2<br />

Standard Tcl Procedure Layout<br />

#####################################################################<br />

#<br />

# browse - browse an object, given its ID<br />

#<br />

# This routine is bound to the "Show" button, and is invoked when<br />

# that button is clicked. If the argument (the contents of...<br />

#<br />

# SYNOPSIS<br />

# .tS<br />

# browse [objAddr | symbol | &symbol]<br />

# .tE<br />

#<br />

# PARAMETERS<br />

# .IP <br />

# the address of an object to browse<br />

# .IP <br />

# a symbolic address whose contents is the address of<br />

# an object to browse<br />

# .IP <br />

# a symbolic address that is the address of an object to browse<br />

#<br />

# RETURNS: N/A<br />

#<br />

# ERRORS: N/A<br />

#<br />

proc browse {args} {<br />

...<br />

}<br />

328

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!