[GitHub] incubator-quarks pull request: [QUARKS-121] [WIP] Fix JavaDoc erro...

[dlaboss]

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>


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---