[
https://issues.apache.org/jira/browse/STORM-1218?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15013803#comment-15013803
]
ASF GitHub Bot commented on STORM-1218:
---------------------------------------
Github user ptgoetz commented on the pull request:
https://github.com/apache/storm/pull/891#issuecomment-158109736
@revans2 Yes, it is inserted into the generated HTML. Since javadoc isn't
part of the source release, it probably only needs to be added to the LICENSE
for the binary distribution.
> 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)
