Uploaded image for project: 'Log Tool'
  1. Log Tool
  2. LOGTOOL-114

Add annotation to help reporting add links to resolution topics

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Done
    • Icon: Major Major
    • 2.1.0.Beta1
    • None
    • None

      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.

      Examples
      @BaseURL("http://foo.com/codes#") // for anchors
      �@BaseURL("http://foo.com/codes/") // for pages
      
      @ResolutionDoc(path = "CODE0001.adoc")
      @ResolutionDoc(url = "http://foo.com/code", suffix = ".adoc")
      @ResolutionDoc(suffix = ".adoc")
      

      For suffix the generated id would be used. In the examples above the file name would be CODE0001.adoc.

            jperkins-rhn James Perkins
            jperkins-rhn James Perkins
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: