Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update to latest
Contents

Table of Contents
maxLevel5
minLevel2

Overview

The following style proposals are inspired by a number of sources, most notably the JavaDoc style guide in How to Write Doc Comments for the Javadoc Tool. The Microsoft Guide to Technical Publications is also a useful reference for general documentation style questions.

...

  • A switch control with on and off states. (preferred)
  • A Switch is created by the method `Titanium`Ti.UI.createSwitch.` (avoid)

...

No Format
borderStyledashed

summary: Returns the image as a `Blob`.
returns: 
    type: Titanium.Blob

...

No Format
borderStyledashed

Titanium binding for an Android activity. For more information on Android activities, see the 
[Activity Reference Page](http://developer.android.com/reference/android/app/Activity.html) on the Android Developer site.

...

No Format
borderStyledashed

For more information on Android Activity, see: 

-  [developer.android.com/reference/android/app/Activity.html](http://developer.android.com/reference/android/app/Activity.html)}} (preferred)

...

No Format
borderStyledashed

Titanium binding for an an [Android Activity](http://developer.android.com/reference/android/app/Activity.html).

...

When deprecating an API, add the deprecated tag. You must specify a since version. You should specify a notes field directing the user to the replacement API or APIs.

Code Block

deprecated:
    since: "37.0.0"
    notes: Use [SOMETHING_ELSE](Titanium.UI.SOMETHING_ELSE) instead.

...

When the API is removed, add the removed version to the deprecated tag. DO NOT remove the API from the docs.

Code Block

deprecated:
    since: "37.0.0"
    notes: Use [SOMETHING_ELSE](Titanium.UI.SOMETHING_ELSE) instead.
    removed: "48.0.0"

Removed APIs should stay in the docs (marked as removed) for a full deprecation cycle. That is, if APIs deprecated in release A are removed in release B, the APIs removed in release A can be removed from the doc in release B.

...

No Format
borderStyledashed

- description: |
      Specify one of: <Titanium.Beverage.WHISKY_ISLAY>, <Titanium.Beverage.WHISKY_HIGHLAND>, <Titanium.Beverage.WHISKY_LOWLAND>.

- summary: |
      `true` if the current view is awesome.

Optional parameters: specify optional method parameters by specifying "optional: true" and adding a default value.

No Format
borderStyledashed

parameters:
  - name: cubes
    summary: Number of ice cubes.
    type: Number
    optional: true
    default: 0

...

No Format
borderStyledashed
   - name: glass
    summary: Glass type, one of <Titanium.Beverage.GLASS_ROCKS> or <Titanium.Beverage.GLASS_COCKTAIL>. Only used on Android.
    optional: true
    default: Titanium.Beverage.GLASS_ROCKS