[
https://issues.apache.org/jira/browse/UIMA-239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12472020
]
J William Murdock commented on UIMA-239:
----------------------------------------
Here is variant of Adam's alternative: add a new, optional element to the
descriptor called "comments"; this could be used for licensing information or
whatever else a developer wants. The existing description field can be used
for this purpose, but there are plenty of kinds of information that don't
really belong in a description of the component but should be expressed in free
text that anyone viewing the descriptor would see, e.g., licensing,
availability, contact information, links to additional documentation, etc.
> Tools like the CDE which use XML parsing should preserve XML comments;
> parsers should provide access to XML comments.
> ---------------------------------------------------------------------------------------------------------------------
>
> Key: UIMA-239
> URL: https://issues.apache.org/jira/browse/UIMA-239
> Project: UIMA
> Issue Type: Improvement
> Components: Core Java Framework, Tools
> Reporter: Marshall Schor
>
> An example of a problem which happens if this is not done: the descriptors
> that come with the UIMA toolkit have a comment that specifies the license
> information for that file. If you edit a descriptor containing such a comment
> with the CDE, it strips out all comments.
> An alternative for license info: add a new, optional element to the
> descriptor for specifying the license (but this might be ambigious as to
> what is being licensed - the descriptor file or what it refers to or ??? )
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
