From FreeSmartphoneWiki

Purpose of a specification is to provide interoperatibility between implementations.

Contents 1 Dbus APIs 1.1 Phase 0 (Brainstorming) 1.2 Phase 1 (First Draft) 1.3 Phase 2 (Draft + Implementation) 1.4 Phase 3 (Stable) 2 Policies 2.1 DBus API Style Guide 2.2 Documentation

Dbus APIs

Phase 0 (Brainstorming)

• Device API: A Dbus API for a device abstraction.
• Usage API: A Dbus API for a expressing subsystem usage requirements.
• Phone API : High level abstraction of a voice phone call

Phase 1 (First Draft)

• Event API: A Dbus API for a expressing event notifications.

Phase 2 (Draft + Implementation)

• Open Telephony API: A Dbus API for high level access to a GSM telephony stack
• Preferences API : A Dbus API for preference settings access

Phase 3 (Stable)

... nothing yet ...

Policies

DBus API Style Guide

• Bus names are all lowercase with . separation, e.g. org.freesmartphone.odeviced
• Object names all lowercase with / separation, e.g. /org/freesmartphone/device/idlenotifier/0
• Method and Signal names are CamelCased, e.g. ListFoo, GetBar.
• Use Get/Set prefixes for accessors (GetServiceCenter, SetServiceCenter)
• Use verbs for operations (ListProviders, Unlock, SendAuthCode)
• Use similar terms for similar operations (ListProviders, ListCells)
• Keep the vocabulary as simple as possible, but as large as necessary

Documentation

Valid doc attributes and their usage:

• para = purpose of an interface
• description = purpose of a method
• summary = purpose of a parameter
• inote = implementation note