Skip to content

Commit

Permalink
Small changes to reduce instances of long comment suppression
Browse files Browse the repository at this point in the history
  • Loading branch information
dickschoeller committed Jan 6, 2017
1 parent 1dd7486 commit b168ca8
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
/**
* @author Dick Schoeller
*/
@SuppressWarnings("PMD.CommentSize")
public final class DefaultRenderer extends GedRenderer<GedObject> {
/**
* This constructor is public for testing purposes only. Do
* not try to call it outside of the context of the rendering
* engine.
* This constructor is public for testing purposes only. Do not try to
* call it outside of the context of the rendering engine.
*
* @param gedObject the gedObject from the parent renderer
* @param rendererFactory the renderFactory from the parent renderer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
*
* @author Dick Schoeller
*/
@SuppressWarnings({ "PMD.CommentSize" })
public final class FamilyRenderer extends GedRenderer<Family> {
/** */
private static final int INDENT_INCREMENT = 2;
Expand Down Expand Up @@ -62,9 +61,8 @@ public List<GedRenderer<?>> getAttributes() {
}

/**
* This method is public for testing purposes only. Do
* not try to call it outside of the context of the rendering
* engine.
* This method is public for testing purposes only. Do not try to call it
* outside of the context of the rendering engine.
*
* @param builder Buffer for holding the rendition
* @param pageRenderer The page renderer that is invoking this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
*
* @author Dick Schoeller
*/
@SuppressWarnings("PMD.CommentSize")
public class NameNameHtmlRenderer implements NameHtmlRenderer {
/**
* Holder for the NameRenderer that is using this helper.
Expand All @@ -17,9 +16,8 @@ public class NameNameHtmlRenderer implements NameHtmlRenderer {
/**
* Constructor.
*
* This constructor is public for testing purposes only. Do
* not try to call it outside of the context of the rendering
* engine.
* This constructor is public for testing purposes only. Do not try to call
* it outside of the context of the rendering engine.
*
* @param nameRenderer the renderer that this is associated with.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*
* @author Dick Schoeller
*/
@SuppressWarnings({ "PMD.CommentSize", "PMD.GodClass" })
@SuppressWarnings({ "PMD.GodClass" })
public final class PersonRenderer extends GedRenderer<Person> {
/**
* Number of generations, including the root when rendering the tree.
Expand Down Expand Up @@ -44,9 +44,8 @@ public PersonRenderer(final Person gedObject,
}

/**
* This method is public for testing purposes only. Do
* not try to call it outside of the context of the rendering
* engine.
* This method is public for testing purposes only. Do not try to call it
* outside of the context of the rendering engine.
*
* @param builder Buffer for holding the rendition
* @param pad Minimum number spaces for padding each line of the output
Expand All @@ -58,9 +57,8 @@ public void renderFather(final StringBuilder builder,
}

/**
* This method is public for testing purposes only. Do
* not try to call it outside of the context of the rendering
* engine.
* This method is public for testing purposes only. Do not try to call it
* outside of the context of the rendering engine.
*
* @param builder Buffer for holding the rendition
* @param pad Minimum number spaces for padding each line of the output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@
import org.schoellerfamily.gedbrowser.renderer.RenderingContext;

/**
* All of these tests should return Living. The reason
* is that the user created is one who shows up living
* in the test. Therefore, the renderer will punt, no
* All of these tests should return Living. The reason is that the user created
* is one who shows up living in the test. Therefore, the renderer will punt, no
* matter what the input string.
*
* There is a separate set of tests with a logged in
* user. Those should get real rendering.
* There is a separate set of tests with a logged in user. Those should get real
* rendering.
*
* @author Dick Schoeller
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
/**
* @author Dick Schoeller
*/
@SuppressWarnings("PMD.CommentSize")
public final class IndexRendererTest {

/**
Expand Down Expand Up @@ -72,7 +71,6 @@ public void testSurnames() throws IOException {

/**
* Prepare the expect string for index html test.
*
* @param id person's ID
* @param surname person's surname
* @param prefix person's given name
Expand Down

0 comments on commit b168ca8

Please sign in to comment.