From 5366b1f684ec32cdd9deded3869a3d494ccaa42a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20K=C3=BChne?= Date: Sun, 20 Feb 2005 06:43:54 +0000 Subject: [PATCH] javadoc clarification in response to bug report #1120653 --- .../com/puppycrawl/tools/checkstyle/api/FileContents.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FileContents.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FileContents.java index 3002b254e..1c016648b 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FileContents.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FileContents.java @@ -110,7 +110,7 @@ public final class FileContents implements CommentListener /** * Returns a map of all the C++ style comments. The key is a line number, - * the value is the comment at the line. + * the value is the comment {@link TextBlock} at the line. * @return the Map of comments */ public Map getCppComments() @@ -153,7 +153,8 @@ public final class FileContents implements CommentListener /** * Returns a map of all C style comments. The key is the line number, the - * value is a list of C style comments at the line. + * value is a {@link List} of C style comment {@link TextBlock}s + * that start at that line. * @return the map of comments */ public Map getCComments()