<style>
/* Changing the layout to use less space for mobiles */
@media screen and (max-device-width: 480px), screen and (-webkit-min-device-pixel-ratio: 2) {
#email-body { min-width: 30em !important; }
#email-page { padding: 8px !important; }
#email-banner { padding: 8px 8px 0 8px !important; }
#email-avatar { margin: 1px 8px 8px 0 !important; padding: 0 !important; }
#email-fields { padding: 0 8px 8px 8px !important; }
#email-gutter { width: 0 !important; }
}
</style>
<div id="email-body">
<table id="email-wrap" align="center" border="0" cellpadding="0" cellspacing="0" style="background-color:#f0f0f0;color:#000000;width:100%;">
<tr valign="top">
<td id="email-page" style="padding:16px !important;">
<table align="center" border="0" cellpadding="0" cellspacing="0" style="background-color:#ffffff;border:1px solid #bbbbbb;color:#000000;width:100%;">
<tr valign="top">
<td bgcolor="#3e4c4e" style="background-color:#3e4c4e;color:#ffffff;font-family:Arial,FreeSans,Helvetica,sans-serif;font-size:12px;line-height:1;"><img src="https://www.jboss.org/dms/hibernate/images/jira/jiraheader_hibernate.png" alt="" style="vertical-align:top;" /></td>
</tr><tr valign="top">
<td id="email-banner" style="padding:32px 32px 0 32px;">
<table align="left" border="0" cellpadding="0" cellspacing="0" width="100%" style="width:100%;">
<tr valign="top">
<td style="color:#505050;font-family:Arial,FreeSans,Helvetica,sans-serif;padding:0;">
<div id="email-action" style="padding: 0 0 8px 0;font-size:12px;line-height:18px;">
<a class="user-hover" rel="emmanuel" id="email_emmanuel" href="https://hibernate.onjira.com/secure/ViewProfile.jspa?name=emmanuel" style="color:#6c797f;">Emmanuel Bernard</a>
edited a comment on <img src="https://hibernate.onjira.com/images/icons/bug.gif" height="16" width="16" border="0" align="absmiddle" alt="Bug"> <a style='color:#6c797f;text-decoration:none;' href='https://hibernate.onjira.com/browse/BVAL-322'>BVAL-322</a>
</div>
<div id="email-summary" style="font-size:16px;line-height:20px;padding:2px 0 16px 0;">
<a style='color:#6c797f;text-decoration:none;' href='https://hibernate.onjira.com/browse/BVAL-322'><strong>Formatting and style improvements</strong></a>
</div>
</td>
</tr>
</table>
</td>
</tr>
<tr valign="top">
<td id="email-fields" style="padding:0 32px 32px 32px;">
<table border="0" cellpadding="0" cellspacing="0" style="padding:0;text-align:left;width:100%;" width="100%">
<tr valign="top">
<td id="email-gutter" style="width:64px;white-space:nowrap;"></td>
<td>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td colspan="2" style="color:#000000;font-family:Arial,FreeSans,Helvetica,sans-serif;font-size:12px;padding:0 0 16px 0;width:100%;">
<div class="comment-block" style="background-color:#edf5ff;border:1px solid #dddddd;color:#000000;padding:12px;"><p>Definitive rules by the Book Of Emmanuel are:</p>
<ul class="alternate" type="square">
<li>use <span class="error">[...]</span> for omissions, prefer it on a dedicated line rather than inlined. For declaration, use a ; after {{User user = <span class="error">[...]</span>;}}</li>
<li>remove email in @author</li>
<li>use @author on non inner classes or interfaces</li>
<li>do not use <tt><programlisting role="JAVA" language="JAVA></tt> as we have not introduced the plumbing</li>
<li>use {@link} for method reference (the first in the JavaDoc of the element) except if it references external classes and if it references the class or element at bay.</li>
<li>reference methods with () but be careful that some methodname are actually annotation attributes and thus should not have ()</li>
<li>in the spec use <methodname>Foo.bar()</methodname> and in the JavaDoc {@link Foo#bar()}</li>
<li>no import statement</li>
<li>add package statement</li>
<li>use <p/> to separate paragraphs but do not use <p>blah blah</p></li>
<li>empty line between the @param, @return, @trhows group and the other @tag elements</li>
<li>something is true but a method returns <tt><literal>true</literal></tt></li>
<li>use <ul> for lists</li>
<li><li> are indented by 4 spaces compared to <ul></li>
<li>multiline @param or @return are indented to align with the beginning of the text of the element</li>
<li>The core of the JavaDoc uses capital letters and punctuation like in plain English</li>
<li>@tag attributes do not use capital letters for the beninning of a sentence nor use dots in the end, prefer ; to separate sentences in this situation</li>
<li>Use verbs at the third person instead of the imperative tense (?!): Returns foo instead of Return foo.</li>
</ul>
<p>Here is an example</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">/**
* Returns the complementary elements related to {@link FooBar#baz()}.
* This allows to <span class="code-keyword">break</span> things apart.
* <p/>
* Demolition mileage may vary depending on the robustness
* of {@code FooBar} when using {@code List}:
* <ul>
* <li>This is a beginning</li>
* <li>This is the end</li>
* </ul>
*
* @param test <span class="code-keyword">this</span> is a <span class="code-object">long</span> description that needs
* to be done on several lines, yep
* @param foo <span class="code-keyword">this</span> is another param
* @<span class="code-keyword">return</span> the result
* @<span class="code-keyword">throws</span> {@code IllegalArgumentException} when things happen
*
* @since 1.1
* @deprecated
*/
<span class="code-keyword">public</span> void someMethod() {
User user = [...];
[...]
}
/**
* Welcome to <span class="code-keyword">this</span> element related to {@link FooBar}.
* This allowed to <span class="code-keyword">break</span> things apart.
* <p/>
* Demolition mileage may vary depending on the robustness
* of {@code FooBar} when using {@code List}
*
* @author Emmanuel Bernard
* @since 1.1
* @deprecated
*/
<span class="code-keyword">public</span> class GoodStuff {
[...]
}</pre>
</div></div></div>
<div style="color:#505050;padding:4px 0 0 0;"> </div>
</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
</td><!-- End #email-page -->
</tr>
<tr valign="top">
<td style="color:#505050;font-family:Arial,FreeSans,Helvetica,sans-serif;font-size:10px;line-height:14px;padding: 0 16px 16px 16px;text-align:center;">
This message is automatically generated by JIRA.<br />
If you think it was sent incorrectly, please contact your JIRA administrators<br />
For more information on JIRA, see: <a style='color:#6c797f;' href='http://www.atlassian.com/software/jira'>http://www.atlassian.com/software/jira</a>
</td>
</tr>
</table><!-- End #email-wrap -->
</div><!-- End #email-body -->