[kepler-dev] Kepler Documentation system
Chad Berkley
berkley at nceas.ucsb.edu
Tue Mar 21 09:58:19 PST 2006
It seems like maybe the documentation should follow the blogging comment
format where when you add a new bit of information (a comment) it just
gets added to the bottom of the documentation (the main story in a
blog). It should probably even say who added the info and when.
chad
Dan Higgins wrote:
> Hi All,
>
> I have been working with the current documentation system in Kepler
> as originally implemented by Edward and extended by Christopher and
> Nandita. I think the doclet works pretty well at pulling information
> about ports, parameters, and actors from the source code and creating an
> easily readable html-based display in Kepler. This can be customized
> with the custom information stored in the MOML for a workflow.
> One issue that I find is that the custom documentation completely
> replaces the doclet/source based documentation. Thus, if you add just
> one custom field, all the source-based documentation disappears. I think
> it might be better if the two source were somehow 'merged' so that field
> where custom data is missing show the source data (and we might want
> some additional fields in the custom documentation editor).
> Any other thoughts on this?
>
> Dan
>
More information about the Kepler-dev
mailing list