Skip to content

Commit

Permalink
Issue #3906: update documentation for usage of period property at Sum…
Browse files Browse the repository at this point in the history
…maryJavadoc
  • Loading branch information
sagarshah94 authored and rnveach committed Mar 7, 2017
1 parent e70836b commit 8e64917
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions src/xdocs/config_javadoc.xml
Expand Up @@ -1628,12 +1628,29 @@ public boolean isSomething()
</p>
<source>
&lt;module name=&quot;SummaryJavadocCheck&quot;&gt;
&lt;property name=&quot;period&quot; value=&quot;STRING_LITERAL&quot;/&gt;
&lt;property name=&quot;period&quot; value="。"/&gt;
&lt;/module&gt;
</source>
</subsection>

<subsection name="Example of Usage">
<p>
Example of period property.
</p>

<source><![CDATA[
public class TestClass {
/**
* This is invalid java doc.
*/
void invalidJavaDocMethod() {
}
/**
* This is valid java doc。
*/
void validJavaDocMethod() {
}
}
]]></source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SummaryJavadoc">
Expand Down

0 comments on commit 8e64917

Please sign in to comment.