[jboss-jira] [JBoss JIRA] (LOGTOOL-114) Add annotation to help reporting add links to resolution topics

[James Perkins (JIRA)]

     [ https://issues.jboss.org/browse/LOGTOOL-114?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

James Perkins reassigned LOGTOOL-114:
-------------------------------------

    Assignee: James Perkins


> Add annotation to help reporting add links to resolution topics
> ---------------------------------------------------------------
>
>                 Key: LOGTOOL-114
>                 URL: https://issues.jboss.org/browse/LOGTOOL-114
>             Project: Log Tool
>          Issue Type: Enhancement
>            Reporter: James Perkins
>            Assignee: James Perkins
>
> It may be useful to add links to generated reports.
> For example in the below adoc report the {{CODE0001}} could be changed to a link which points to a resolution document.
> ||Message Id||Message||Log Level||Return Type||
> |CODE0001| Failed to start container: %s|—|java.lang.String|
> Resolution documents could be documents in the projects or full URL's. The annotation can be placed on the top level interface meaning every method will be generated or placed on a method.
> {code:title=Examples}
> @BaseURL("http://foo.com/codes#") // for anchors
> @BaseURL("http://foo.com/codes/") // for pages
> {code}
> {code}
> @ResolutionDoc(path = "CODE0001.adoc")
> @ResolutionDoc(url = "http://foo.com/code", suffix = ".adoc")
> @ResolutionDoc(suffix = ".adoc")
> {code}
> For {{suffix}} the generated id would be used. In the examples above the file name would be {{CODE0001.adoc}}.



--
This message was sent by Atlassian JIRA
(v7.2.3#72005)