[e-lang] Bug (0.8.26g): Object doc-comments not preserved
Mark S. Miller
markm at caplet.com
Thu Apr 15 15:53:13 EDT 2004
At 04:37 AM 4/15/2004 Thursday, Kevin Reid wrote:
>The latter, since duplicating it would result in lengthy duplicate output
>from help() (assuming it is modified to print object doc comments, which
>Consider the revision of a function object into one with multiple methods -
>the sole doc-comment for the function likely contains such things as
>descriptions of arguments, return value, and side-effects, which would
>become specific to the run method.
Good points. I'll move the comment to the generated run method, and make the
object definition comment say something to effect of "See the run method".
What about tags that (by Javadoc conventions) applies only to the "class
level" (i.e., our object definition level) rather than the method level,
like @author? Should we keep these with the object definition comment?
(I think so, though I would have liked to avoid doc-comment parsing in
expanding E to Kernel-E.)
Text by me above is hereby placed in the public domain
More information about the e-lang