On Friday, May 20, 2005, 7:31:10 PM, gabriele wrote:
> Hi guys,
> I was thinking of documenting BigDecimal.c and related
> libraries.
> In the process, I discovered that there already *is*
> documentation in cvs in the form of an html file.
> So it's just a matter of putting that back into
> bigdecimal.c and related files.
> But the question is: what about existing non-rdoc
> comments in the file?
Hi Gabriele,
If the comments in bugdecimal.c are not for RDoc, they can be ignored.
I notice some methods are documented, but they're probably private
methods - the comments seem pretty technical.
So adding all that stuff from the HTML back into the source seems like
a good idea. Would you include *all* the general usage stuff? I say
go for it; make that separate HTML page redundant.
Cheers,
Gavin
|
