This section explains the most important aspects of the way these SDK examples have been documented and briefly describes the various documentation methods used.
|
|
|
The examples have been chosen to demonstrate a range of Symbian OS and S60 object-oriented design and programming techniques.
|
|
|
The examples are relevant to Symbian OS version 9.1 and the S60 user interface package.
|
|
|
As far as possible, the example code follows relevant C++, Symbian OS and Nokia coding conventions. A full list of the conventions is given in the Coding Conventions section.
|
|
|
The examples are all built in the same way. Instructions on building and running them are provided in Building and Running Example Applications.
|
|
|
This chapter describes the structure and general contents of example application documentation.
1. About this Example - This section includes a brief introduction to the example, explaining what the example application is about, covering, for example the following issues:
What the example application demonstrates.
How the example application can be used in real practice.
The most important API classes used in the example application.
2. Prerequisites - This section outlines the prerequisites for building and running the example, such as the skills and/or knowledge needed. The section includes also the following information:
Knowledge domains and important architecture frameworks that assume the user's understanding for working with this example application.
Important device or hardware features and capabilities that assume the user's understanding for working with this example application.
If an application does not support scalable UI, it is informed in this section.
3. Design and Implementation - This section provides a short description of how the application is designed and implemented. The most important operations that are invoked directly from the UI are explained. Other important methods are also documented if possible.
3.1. Capabilities - This subsection lists the capabilities of the application.
3.2. ScalableUI - This subsection describes how the program works with different screen modes.
Other subsections are example-specific and describe the design and implementation issues at an appropriate level.
Class Hierarchy - This section lists the definitions of the local-defined classes and describes their hierarchy.
|
© Nokia 2006 |
|