Conventions

Table 4 – Typographic conventions
Convention	Purpose	Example
courier	Function names, code, directories, file names, examples, operating system commands, URLs. SQL code is slightly larger than C++ code.	RWWinSockInfo info; cout << "Error Processing:" Visit us at www.roguewave.com
italic	Variables Conventional uses, such as new terms and titles.	<table> Functors, or function objects… Reference Guide
bold italic	Class names, emphasis, and some subheads.	RWCollectable
bold	Conventional uses, such as emphasis. Commands from an interface.	You should always read the manual. Click the OK button
ellipsis	Indicates part of the code is missing from an example.	foo(){ . //Something . //happens .}

Table 5 – Pathname conventions
Convention	Purpose	Example
buildspace	The name you gave the directory where your Rogue Wave components are built.	buildspace\docs\index.html
\	The Windows delimiter in a path name. If you use Unix, replace \ with /.	For docs\html, a Unix user enters docs/html.
mnemonic	A placeholder for a module mnemonic.	buildspace\docs\html\mnemonicref
mnemonic	These are the mnemonics associated with each module: Essential Tools Module: tools Threads Module: threads Internationalization Module: i18n Advanced Tools Module: advtools XML Streams Module: xmlstreams DB Interface Module: dbcore DB Access Module for DB2 CLI: db2cli DB Access Module for MS SQL Server: mssql DB Access Module for MySQL: mysql DB Access Module for ODBC: odbc DB Access Module for Oracle OCI (9i and 10g): oracleoci DB Access Module for PostgreSQL: postgresql DB Access Module for Sybase: sybasect Essential Networking Module: networking Internet Protocols Module: protocols Secure Communication Module: security Essential Math Module: math Linear Algebra Module: lapack Business Analysis Module: analytics Currency Module: currency

All Rogue Wave C++ class names start with the letters RW, as in RWInterval. In some cases, an instance of a class is referred to by an English name; for example, “the linear regression” instead of “the RWLinearRegression.” This makes the text easier to read when the meaning should be clear from context, but we use the specific form if there is possible ambiguity.

All function names begin with a lower case letter, with the first letter of subsequent words capitalized. Function names attempt to accurately describe what a function does. For example, RWInterval::lowerBound() returns an interval's lower bound. Underline characters and abbreviations are not generally used in function names.