Skip to main content
summaryrefslogtreecommitdiffstats
path: root/codan
diff options
context:
space:
mode:
authorAlena Laskavaia2016-01-07 20:15:32 -0500
committerGerrit Code Review @ Eclipse.org2016-01-07 20:49:41 -0500
commitaa4f014a3a5272b876c2fcb81c6c9658e626fd6e (patch)
tree6ef81d80217ff68c5e911dd42b16133672874ee6 /codan
parentd3e933501eb387cbf2e1c9c211ec8fac358f817b (diff)
downloadorg.eclipse.cdt-aa4f014a3a5272b876c2fcb81c6c9658e626fd6e.tar.gz
org.eclipse.cdt-aa4f014a3a5272b876c2fcb81c6c9658e626fd6e.tar.xz
org.eclipse.cdt-aa4f014a3a5272b876c2fcb81c6c9658e626fd6e.zip
fixing some comments
Diffstat (limited to 'codan')
-rw-r--r--codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/internal/model/CodanCommentMap.java19
-rw-r--r--codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/model/ICodanCommentMap.java45
2 files changed, 24 insertions, 40 deletions
diff --git a/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/internal/model/CodanCommentMap.java b/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/internal/model/CodanCommentMap.java
index 8318d81e3b..80ea21ecfb 100644
--- a/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/internal/model/CodanCommentMap.java
+++ b/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/internal/model/CodanCommentMap.java
@@ -30,35 +30,16 @@ public class CodanCommentMap implements ICodanCommentMap {
this.commentedNodeMap = commentedNodeMap;
}
- /*
- * (non-Javadoc)
- *
- * @see org.eclipse.cdt.codan.core.cxx.model.ICodanCommentMap#
- * getTrailingCommentsForNode(org.eclipse.cdt.core.dom.ast.IASTNode)
- */
@Override
public List<IASTComment> getTrailingCommentsForNode(IASTNode node) {
return commentedNodeMap.getTrailingCommentsForNode(node);
}
- /*
- * (non-Javadoc)
- *
- * @see org.eclipse.cdt.codan.core.cxx.model.ICodanCommentMap#
- * getLeadingCommentsForNode(org.eclipse.cdt.core.dom.ast.IASTNode)
- */
@Override
public List<IASTComment> getLeadingCommentsForNode(IASTNode node) {
return commentedNodeMap.getLeadingCommentsForNode(node);
}
- /*
- * (non-Javadoc)
- *
- * @see
- * org.eclipse.cdt.codan.core.cxx.model.ICodanCommentMap#getFreestandingForNode
- * (org.eclipse.cdt.core.dom.ast.IASTStatement)
- */
@Override
public List<IASTComment> getFreestandingForNode(IASTNode node) {
return commentedNodeMap.getFreestandingCommentsForNode(node);
diff --git a/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/model/ICodanCommentMap.java b/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/model/ICodanCommentMap.java
index 5615376ef0..318a15f4bf 100644
--- a/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/model/ICodanCommentMap.java
+++ b/codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/model/ICodanCommentMap.java
@@ -20,11 +20,8 @@ import org.eclipse.cdt.core.dom.ast.IASTNode;
*/
public interface ICodanCommentMap {
/**
- * Returns an Collection of comments for the given node (after the node).
- * This list contains all the comments
- * which are assigned to this specific node. If no comments are available an
- * empty
- * collection is returned.
+ * Returns a List of comments for the given node (following the node).
+ * If no comments are available an empty list is returned.
*
* @param node The key to fetch the associated comments.
* @return list of comments
@@ -32,42 +29,48 @@ public interface ICodanCommentMap {
public List<IASTComment> getTrailingCommentsForNode(IASTNode node);
/**
- * Returns an Collection of comments for the given node (before the node).
- * This list contains all the comments
- * which are assigned to this specific node. If no comments are available an
- * empty
- * collection is returned.
+ * Returns a List of all comments for the given node (preceding the node).
+ * If no comments are available an empty list is returned.
*
* @param node The key to fetch the associated comments.
* @return list of comments
*/
public List<IASTComment> getLeadingCommentsForNode(IASTNode node);
-
/**
- * Returns an ArrayList for the given node. This ArrayList contains all the comments
- * which are assigned to this specific node. If no comments are available an empty
- * ArrayList is returned.
+ * Returns a List of comments associated with the given node.
+ * If no comments are available an empty list is returned.
+ *
+ *
* @param node The key to fetch the associated comments.
- * @return ArrayList
+ * @return list of comments
*/
public List<IASTComment> getFreestandingForNode(IASTNode node);
/**
- * @param node
- * @return
+ * Gets last comment from {@link #getLeadingCommentsForNode(IASTNode)}, or
+ * null if list is empty
+ *
+ * @param node - The key to fetch the associated comments.
+ * @return - A comment node or null if not found.
*/
public IASTComment getLastLeadingCommentForNode(IASTNode node);
/**
- * @param node
- * @return
+ * Gets first comment from {@link #getTrailingCommentsForNode(IASTNode)} or
+ * null if list is empty.
+ *
+ * @param node - The key to fetch the associated comments.
+ * @return - A comment node or null if not found.
*/
public IASTComment getFirstTrailingCommentForNode(IASTNode node);
/**
- * @param node
- * @return
+ * Gets last comment from {@link #getFreestandingForNode(IASTNode)} or
+ * null if list is empty.
+ *
+ * @param node - The key to fetch the associated comments.
+ * @return - A comment node or null if not found.
*/
public IASTComment getLastFreestandingCommentForNode(IASTNode node);
}

Back to the top