org.freesmartphone.GSM/README

   1 WHAT IS IT
   2 ==========
   3
   4 The files in this directory are DBus interface descriptions.
   5
   6 See http://www.freesmartphone.org/mediawiki/index.php/Standards/OpenPhoneServerAPI
   7
   8 TODO
   9 ====
  10 * Introductionary docs
  11 * Error specification / handling
  12 * Sorting
  13 * Cross-references
  14 * Strip <error> directives out (fix spec-strip-docs.xsl)
  15
  16 CR (change requests)
  17 ==========================
  18 ADD: org.freesmartphone.GSM.SIM.SendMessage
  19 CHANGENAME: org.freesmartphone.GSM.Network.GetStatus + .Status -> GetNetworkStatus + .NetworkStatus
  20 CHANGESIG: org.freesmartphone.GSM.Network.GetStatus + .Status
  21
  22 Hacking notes
  23 =============
  24
  25 Docs:
  26
  27 Valid doc attributes and their usage:
  28 * para = purpose of an interface
  29 * description = purpose of a method
  30 * summary = purpose of a parameter
  31 * inote = implementation note
  32
  33 Style Guide:
  34 * dbus methods and signals are CamelCased
  35 * Use Get/Set prefixes for accessors (GetServiceCenter, SetServiceCenter)
  36 * Use Verbs for operations (ListProviders, Unlock, SendAuthCode)
  37 * Use similar terms for similar operations (ListProviders, ListCells)
  38
  39 Committing:
  40 * run 'make check' before checking specs in
  41
  42 PDF and other file formats:
  43 * you can use the 'xmlto' utility to generate the docbook version, e.g.
  44   'xmlto html docbook-otapi.xml'