search

gravitylow / Updater

Easy automatic updates for Bukkit
MIT License
35 stars 41 forks source link

Fix paragraph tag in javadoc #26

Closed NicholasFeldman closed 9 years ago

NicholasFeldman commented 9 years ago

Gradle was throwing an error during build because of these incorrect paragraph tags:

ss 2015-01-23 at 10 59 37

gravitylow commented 9 years ago

Interesting. Thanks for the PR!

feildmaster commented 9 years ago

So gradle doesn't allow for valid HTML?

NicholasFeldman commented 9 years ago

As of HTML5 (as far as I am aware) only void elements are allowed to be self closing. (Section 8.1.2)

feildmaster commented 9 years ago

Hmm... javadocs don't normally generate in HTML5.

Also that used to be 2 paragraphs (after the first line). You made it one paragraph and a footnote.

NicholasFeldman commented 9 years ago

So javadocs do generate with HTML 4.01, I was wrong there. Although self closing paragraph tags are accepted by the W3C validator, <p/> will be the same as the <p> tag since HTML parsers simply ignore the slash. If that is the case, then the bottom tag should be changed from </p> to <p>.
I don't see any difference the way it is now however. Above is generated from the change I made, the below is what I saw hosted here. However, if it was intended to be two paragraphs, that is my fault, and the closing tag should be changed. ss 2015-01-29 at 09 33 00 As far as I can tell there is no difference.
I apologize if I did mess up the formatting somewhere, but the point of this PR was to bring attention to the error thrown for the sake of anyone using Gradle. I recommend that this tag be changed to <p> anyway, to change it to the intended two paragraphs.