Nick Wellnhofer wrote on 2/7/16, 8:08 AM:

But with this change, the Perl documentation should use the DocuComment of
`new`, not `init`. There's already a mechanism to specify from which function
the documentation should be taken: The `initializer` parameter of
`CFCPerlPod_add_constructor`.

@param initializer The name of the initialization routine from the
Clownfish class. Defaults to "init".

Maybe we should change this parameter and its default to:

@param pod_func The name of the function from which the constructor's
documentation should be taken. Defaults to "new".

Does that make sense? Related issue:

https://issues.apache.org/jira/browse/CLOWNFISH-41

I understand the need for the change to support C documentation.

As long as the Perl documentation continues to reflect the use of 'new()' the way it does now, I think this change is fine.


--
Peter Karman  .  http://peknet.com/  .  [email protected]

Reply via email to