Next in thread → Next in month →

RE: [docbook-apps] oointerface - writing a synopsis for a Java interface

From
Johnson, Eric <>
Date
2006-12-12T23:21:05+00:00
ID
Thread
RE: [docbook-apps] oointerface - writing a synopsis for a Java interface
I'd be happy to submit a patch, but before doing so I'd like some
confirmation that the intention of class="interface" of the
classsynopsis element is to document an interface synopsis.
 

> -----Original Message-----
> From: Michael(tm) Smith [mailto:] 
> Sent: Tuesday, December 12, 2006 3:24 AM
> To: 
> Subject: Re: [docbook-apps] oointerface - writing a synopsis 
> for a Java interface
> 
> Mauritz Jeanson <>, 2006-12-11 20:20 +0100:
> 
> > One reason for the confusion, I think, is that the official 
> > documentation (The Definitive Guide) isn't detailed enough. In 
> > particular, there are too few usage examples and the 
> processing expectations are often a little vague.
> > 
> > Many descriptions of source code-related elements in TDG 
> don't have a 
> > single example. See 
> http://docbook.org/tdg/en/html/classsynopsis.html, 
> > for instance.
> 
> I think patches to TDG would probably be welcome. The sources 
> are here:
> 
>   
> https://svn.sourceforge.net/svnroot/docbook/trunk/defguide/en/
> refpages/elements
>   
> https://svn.sourceforge.net/svnroot/docbook/trunk/defguide5/en
> /refpages/elements
>
Next in thread → Next in month →