Notation Conventions

Notation Conventions

Text conventions used in this manual are identified and described as follows.

Example

Description

 

 

 

 

Close command

Titles in reference sections indicate the location of an item within the

(File menu)

VisualDSP++ environment’s menu system (for example, the Close

 

command appears on the File menu).

 

 

{this that}

Alternative required items in syntax descriptions appear within curly

 

brackets and separated by vertical bars; read the example as this or

 

that. One or the other is required.

 

 

[this that]

Optional items in syntax descriptions appear within brackets and sepa-

 

rated by vertical bars; read the example as an optional this or that.

 

 

[this,…]

Optional item lists in syntax descriptions appear within brackets

 

delimited by commas and terminated with an ellipse; read the example

 

as an optional comma-separated list of this.

 

 

.SECTION

Commands, directives, keywords, and feature names are in text with

 

letter gothic font.

 

 

filename

Non-keyword placeholders appear in text with italic style format.

 

 

 

Note: For correct operation, ...

 

A Note provides supplementary information on a related topic. In the

 

online version of this book, the word Note appears instead of this

 

symbol.

 

 

 

Caution: Incorrect device operation may result if ...

 

Caution: Device damage may result if ...

 

A Caution identifies conditions or inappropriate usage of the product

 

that could lead to undesirable results or product damage. In the online

 

version of this book, the word Caution appears instead of this symbol.

 

 

 

Warning: Injury to device users may result if ...

 

A Warning identifies conditions or inappropriate usage of the product

 

that could lead to conditions that are potentially hazardous for the

 

devices users. In the online version of this book, the word Warning

 

appears instead of this symbol.

 

 

xxii

ADSP-21369 EZ-KIT Lite Evaluation System Manual

Page 22
Image 22
Analog Devices ADSP-21369 system manual Notation Conventions