×
Namespaces

Variants
Actions

Code snippet template for developers

From Nokia Developer Wiki
Jump to: navigation, search

Delete the guidance text written in italics.

Replace the abstract text below with one or two sentences that briefly describe what the article is about.
This article defines the standard boilerplate text for a new code example


Update as many applicable fields in the ArticleMetaData template as you can. At minimum, make sure to update the creationdate and author fields.

Article Metadata
Article
Created: (09 Nov 2009)
Last edited: BuildNokia (12 Apr 2014)

Contents

Overview

Provide a more detailed description of the purpose of the article. The overview is optional if the detail is fully captured by the Abstract


Preconditions

In complex cases you may need to provide information on the framework needed in order to implement and use the code snippet. For example, a Bluetooth connection must be established in order to use the code snippet "send a file via Bluetooth OBEX". You can refer to an already existing code example.

Note that you wouldn't include the SDK used here if that is obvious from context. You would include SDK information in the ArticleMetaData as this allows users to judge the likely relevance of the article on current SDKs.


Project file (optional)

The following capabilities and libraries are required:

CAPABILITY       
 
LIBRARY
 
LIBRARY

Header file

Not the complete file but relevant code blocks.

 code


Source file

You should link to the complete source code in your Github repository, and call out relevant code blocks here.

You do not need to provide complete error handling but it should be commented as TODO for developers.

code


Postconditions

Explain what the code snippet is expected to do.


Test application and other supplementary information (optional)

If you currently have an app in the store that has implemented what is described here, you can link to it as an example.


This page was last modified on 12 April 2014, at 03:43.
271 page views in the last 30 days.