[jira] [Commented] (QUARKS-121) Fix JavaDoc Error except tag

[ASF GitHub Bot (JIRA)]

    [ 
https://issues.apache.org/jira/browse/QUARKS-121?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15228325#comment-15228325
 ] 

ASF GitHub Bot commented on QUARKS-121:
---------------------------------------

Github user dlaboss commented on a diff in the pull request:

    https://github.com/apache/incubator-quarks/pull/77#discussion_r58713114
  
    --- Diff: 
analytics/sensors/src/main/java/quarks/analytics/sensors/Filters.java ---
    @@ -99,7 +99,7 @@ private Filters() {}
          * <LI>The first tuple.</LI>
          * </UL>
          * <BR>
    -     * <img src="doc-files/deadband.png" alt="Deadband example"/>
    +     * <img src="doc-files/deadband.png" alt="Deadband example">
    --- End diff --
    
    I think the original above is what's needed.  Was the image rendering wrong 
for you?
    
    Thanks for many of the other fixes.
    
    For what it's worth, it seems only the "<" needs to be escaped to avoid 
confusing browsers.  ">" is OK.  So for example, the changes to Connector below 
seem unnecessary.  Were you seeing a rendering problem?
    
    Also &lt;pre> and/or &lt;code> provide some "protection" as well - e.g., 
line 157 in TStream below already renders correctly.
    
    FWIW, I've taken to trying to use the following idiom as it seems "stuff" 
can then basically anything, particularly unescaped "<", so I can just write / 
copy code in its natural form
    &lt;pre>{@code
    stuff...
    }&lt;/pre>


> Fix JavaDoc Error except </P> tag
> ---------------------------------
>
>                 Key: QUARKS-121
>                 URL: https://issues.apache.org/jira/browse/QUARKS-121
>             Project: Quarks
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Cazen Lee
>            Assignee: Cazen Lee
>
> Fix all error when generating JavaDoc except </P> tag
> </P> tag is valid but I think it's bug in Java 1.8



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)