[jira] [Created] (STORM-1218) Use Markdown Syntax for JavaDoc

["P. Taylor Goetz (JIRA)" <ji...@apache.org>]

P. Taylor Goetz created STORM-1218:
--------------------------------------

             Summary: Use Markdown Syntax for JavaDoc
                 Key: STORM-1218
                 URL: https://issues.apache.org/jira/browse/STORM-1218
             Project: Apache Storm
          Issue Type: Bug
            Reporter: P. Taylor Goetz
            Assignee: P. Taylor Goetz


Currently we use the standard HTML-based markup for our JavaDoc documentation, though many JavaDoc comments are not properly formatted. A good example of this multi-paragraph comments without {{<p/>}} tags, which leads to multiple paragraphs being squashed together.

An easy fix for this is to switch to markdown for JavaDoc comments.

Markdown format is also much easier to read in the context of code comments, and it's the format we use for our website and documentation.

Switching to markdown may also encourage developers to better document their code, since it is less cumbersome.



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