mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

fixing some comments

Browse source 
Change-Id: I020815ce6099d743067974a97b8b63539e408f15
This commit is contained in:
Alena Laskavaia 2016-01-07 20:15:32 -05:00 • committed by Gerrit Code Review @ Eclipse.org
parent d3e933501e
commit aa4f014a3a
2 changed files with 24 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/internal/model/CodanCommentMap.java
View file

@ -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);

45
codan/org.eclipse.cdt.codan.core.cxx/src/org/eclipse/cdt/codan/core/cxx/model/ICodanCommentMap.java
View file

@ -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);
}