specification documentation

Michael 'Mickey' Lauer mickey at vanille-media.de
Thu Apr 17 20:45:53 CEST 2008


Hi guys,

I did some work in the specs/otapi directory to enable documentation 
attributes (think literate programming) inside our specs.

The first file containing doc attributes is 
org.freesmartphone.GSM.Device.xml.in. Right now, the following four 
attributes are meaningful:

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

Until now, I'm a docbook illiterate though, so I'd appreciate someone helping 
me with adding the necessary Makefile logic to generate proper output.

Note: Tomorrow I'll move some interfaces as per our discussions (lowlevel 
phonebook and messages services -> SIM). By next week we really need to start 
with error specifications.

Cheers,

:M:
-- 
Dr. Michael 'Mickey' Lauer | IT-Freelancer | http://www.vanille-media.de



More information about the smartphones-standards mailing list