specification documentation

Heikki Paajanen heikki.paajanen at ixonos.com
Fri Apr 18 08:28:58 CEST 2008


Hi Mickey,

I'm not a docbook (nor make) expert, but here is a quick patch for
building the docbook xhtml documentation. I'm not sure how the
stylesheet should be referenced to so I just used absolute path on my
computer (Ubuntu Gutsy). Feel free to change/fix/ignore it ;)

Regards,
	Hessu

On Thu, 2008-04-17 at 21:45 +0300, Michael 'Mickey' Lauer wrote:
> 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
> 
> _______________________________________________
> smartphones-standards mailing list
> smartphones-standards at linuxtogo.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/smartphones-standards
-- 
Heikki Paajanen <heikki.paajanen at ixonos.com>
Ixonos Plc, www.ixonos.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: makefile.patch
Type: text/x-patch
Size: 1342 bytes
Desc: not available
Url : http://lists.linuxtogo.org/pipermail/smartphones-standards/attachments/20080418/7bfe3aff/attachment.bin 


More information about the smartphones-standards mailing list