On Fri, Feb 26, 2016 at 4:12 AM, Nick Wellnhofer <[email protected]> wrote: > On 26/02/2016 04:51, Marvin Humphrey wrote:
>> The only other item of interest was that some classes had an empty >> DESCRIPTION. (String, ByteBuf, CharBuf...). This arises >> whenever the class docucomment contains only a single sentence. > > > Right. This is occurred to me at some point, but I forgot to implement a > fix. I think we can live with these empty sections for now. +1 >> It's always a scalar at least. This could probably be named from the >> type. >> It won't always be accurate (e.g. a Vector will be converted to native >> host >> type, in this case a Perl array ref) and it will be weird if the return >> type >> matches the type of the invocant (`my $hash = $hash->clone()`) but it's >> probably worth the occasional weirdness over sticking with `my $retval = ` >> everywhere. > > > I went with the conservative approach, and used `$retval` for the return > value. Would it be too magical to default to the name of the type and use "retval" only when there's a clash? With all the great work that you've done to improve documentation generation, I've been inspired to sweep through both Lucy and Clownfish and fill out @param and @return tags for every documented public method on a public class. Pull requests on the way... Marvin Humphrey
