[
https://issues.apache.org/jira/browse/LUCY-20?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Marvin Humphrey updated LUCY-20:
--------------------------------
Attachment: 050-docucomment.t
parser_add_docucomment_support.diff
DocuComment.pm
This class got written because Doxygen kept segfaulting on me when I tried to
use it as a pure parser rather than as a complete system. That was a little
while ago, so maybe now Doxygen has been fixed, but this works and I haven't
felt the need to revisit it.
The goal is to share documentation text across multiple bindings, sparing us
as much of the headache of keeping multiple copies in sync as possible.
Obviously code samples need to be per-binding, but with careful language, it's
possible to write text that can be applied multiple times.
Link syntax is still a TODO -- for Perl bindings, I've fallen back to
embedding L<POD> links, but that needs to be dropped in favor of something
more coherent. Right now, JavaDoc syntax is used everywhere else, so probably
that means adding support for {...@link} tags.
> Boilerplater::DocuComment
> -------------------------
>
> Key: LUCY-20
> URL: https://issues.apache.org/jira/browse/LUCY-20
> Project: Lucy
> Issue Type: Sub-task
> Components: Boilerplater
> Reporter: Marvin Humphrey
> Assignee: Marvin Humphrey
> Attachments: 050-docucomment.t, DocuComment.pm,
> parser_add_docucomment_support.diff
>
>
> Add support for structured comments, a la Doxygen.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
