Notational Conventions

Convention

Explanation

Example

Italic

Indicates

  • emphasis

  • the introduction of new terms

  • denotation of terms

  • placeholders

  • titles of manuals

Do not close the project without saving.

The filename consists of the basename and the extension.

The expression and/or denotes an inclusive choice between two or more items.

The bitmap is width pixels wide and len pixels high.

Bold

Denotes elements of the graphical user interface.

The Cancel button of the Start dialog box

Monospace

Indicates

  • filenames, directory names and pathnames

  • commands and command-line options

  • function names, methods, classes, data structures in body text

  • source code

  • ippsapi.h \alt\include ecl-O2
    
  • Use the CreateObj()function to

  • printf("hello, world\n");
    

Monospace italic

Indicates source code parameters, arguments, or other placeholders.

ippiMalloc( int width, int* pStep);

Monospace bold

Indicates input code on a command line or emphasizes parts of source code.

  • [c:] dir

  • x = ( h > 0 ? sizeof(m) : 0xF ) + min;

[ ]

Indicates an optional item.

This is a logical symbol in a syntax description and not a literal part of the syntax.

Fa[c]

Fa or Fac.

{ | }

Indicates the choice of one item from a group of items.

This is a logical symbol in a syntax description and not a literal part of the syntax.

X{A | B | C}

One of XA, XB, or XC.

( | )

Indicates the choice of one or more items from a group of items.

This is a logical symbol in a syntax description and not a literal part of the syntax.

(A | B | C)

A, B, C, or AB, AC, BC, or ABC

"[" "]" "{"

"}" "|" "(" ")"

Negates the logical meaning in a syntax description; the character is taken as a literal.

"[" X "]" [ Y ]

Denotes the letter X enclosed in brackets, optionally followed by the letter Y.

Indicates that the previous item can be repeated several times.

This is a logical symbol in a syntax description and not a literal part of the syntax.

filename

One or more filenames can be specified.

,…

Indicates that the previous item can be repeated several times, separated by commas.

This is a logical symbol in a syntax description and not a literal part of the syntax.

word ,…

One or more words can be specified. If more than one word is specified, the words are comma-separated.

>

Indicates a menu item inside a menu.

File > Close

The Close item in the File menu.

For more complete information about compiler optimizations, see our Optimization Notice.