At 8:27 PM -0600 1/2/03, Richard D. Jackson wrote:
On Fri, 2003-01-31 at 23:06, Frank Heckenbach wrote:
<snip> > Take a look at this > http://java.sun.com/j2se/1.4.1/docs/api/index.html > ignore the stuf at the top and scroll down to the section containing the > method documentation. This is the type of format/output I would like to > see the html ouput engine produce for a function/procedure. I wouldn't > mind seeing that type of output on the texinfo side either but I > definatly want it on the html side. Now to do that type of formating > will require that the documenter mark what is what.
Could you please give an exact URL of the page you mean? The URL above contains a frameset with several menus, I'm not sure exactly what to look at.
Sorry about that try this: http://java.sun.com/j2se/1.4.1/docs/api/java/awt/Paint.html And look at the Method Detail section at the bottom. There happens to be only one method for this but it does show what I'm thinking about.
Spot on. Much like that layout from Web Design in a Nutshell as I was referring to earlier (I did post that didn't I?), but with all the bits together in one place. I still prefer the layout of WDIN as it interates with written documentation well (not the automatic annotations, but the long hand description of the aims and use of some feature which usually written after the fact). Also it means there are short appendices with just the least needed to remind you of the keywords, parameters, etc.
But this style is good for an on-line doc.
FWIW, I'm interested in that particular layout as its how I intend to doc my APIs.
Grant