Product Documentation

Stingray Studio provides full documentation in HTML and PDF formats. The Stingray Studio User Guide is a combined HTML document set that includes the user guide for each individual product. The same is true of the PDF document. The reference guides are in HTML Help .chm format.

The documentation for Objective Grid for Microsoft .NET is provided separately as this is not formally part of the Stingray Studio product, but is available by request.

The organization of the Docs directory is:

These are the types of documents provided with Stingray Studio:

Provides an overview of Stingray Studio including instructions for installing, building libraries, migrating applications, and porting to Microsoft® .NET®.

These documents are how-to manuals and provide an introduction to each component of Stingray Studio. There are several tutorials included to help you learn how to create applications quickly.

These documents are more advanced and include a discussion of the design and architecture of each component. There are several advanced tutorials to help you gain more proficiency with the product. They are separate parts of the user guides, not independent documents.

These documents provide a detailed description of the properties, methods, and events in each component. There is a description for each public class and its methods. The reference guides are available in regular HTML format through the index.html file, and in a combined HTML Help .chm format.

Release notes list the known issues at the time of release for Stingray Studio products. Release notes are provided as a PDF document Stingray Studio <ver> Release Notes in the installer download and on the Rogue Wave web site at www.roguewave.com/support/product-documentation/stingray.aspx.

The Rogue Wave Knowledge Base contains a large body of useful information created by the Support Services team. It has been created to provide our customers with easy access to technical information. Knowledge Base entries range from common programming problems to complete sample programs and are constantly being updated and expanded. This information is available to any user of the Rogue Wave Web site, and no login or registration is required. Go to kb.roguewave.com/kb/.

The documentation for Stingray Studio uses typographic conventions and pathname conventions similar to other Rogue Wave documentation. These conventions are summarized in the following table:

Table 1 – Type Conventions
Item	Example	Definition
Functions, Variables and Parameters	Myfunc()	Library functions are in courier font.
Class Name	CODModel	Class names are bold and italic.
Code	#include <io.h>	Code is in courier font.
Key names, key combinations and key sequences	CTRL+ALT+DEL	All Caps
Menus and menu commands	Select Edit from the File menu.	Menus and menu commands are bold.