Java Code Examples for org.eclipse.jdt.core.dom.BodyDeclaration#getJavadoc()

The following examples show how to use org.eclipse.jdt.core.dom.BodyDeclaration#getJavadoc() . You can vote up the ones you like or vote down the ones you don't like, and go to the original project or source file by following the links above each example. You may check out the related API usage on the sidebar.
Example 1
Source File: UMLModelASTReader.java    From RefactoringMiner with MIT License 6 votes vote down vote up 
private UMLJavadoc generateJavadoc(BodyDeclaration bodyDeclaration) {
	UMLJavadoc doc = null;
	Javadoc javaDoc = bodyDeclaration.getJavadoc();
	if(javaDoc != null) {
		doc = new UMLJavadoc();
		List<TagElement> tags = javaDoc.tags();
		for(TagElement tag : tags) {
			UMLTagElement tagElement = new UMLTagElement(tag.getTagName());
			List fragments = tag.fragments();
			for(Object docElement : fragments) {
				tagElement.addFragment(docElement.toString());
			}
			doc.addTag(tagElement);
		}
	}
	return doc;
}
Example 2
Source File: InJavaImporter.java    From jdt2famix with Eclipse Public License 1.0 5 votes vote down vote up 
public void ensureCommentFromBodyDeclaration(SourcedEntity entity, BodyDeclaration node) {
	if (node.getJavadoc() != null)
		createBasicComment(entity, node.getJavadoc().toString());
	else {
		// if there is no javadoc, we look for single line or multi line comments before
		// the node
		CompilationUnit root = (CompilationUnit) node.getRoot();
		int firstLeadingCommentIndex = root.firstLeadingCommentIndex(node);
		if (firstLeadingCommentIndex >= 0)
			// There seems to be a problem here: JDT does not seem to provide the contents
			// of the comments.
			// Only the types (one line or multi line).
			createBasicComment(entity, root.getCommentList().get(firstLeadingCommentIndex).toString());
	}
}
Example 3
Source File: HierarchyProcessor.java    From Eclipse-Postfix-Code-Completion with Eclipse Public License 1.0 5 votes vote down vote up 
protected static void copyJavadocNode(final ASTRewrite rewrite, final BodyDeclaration oldDeclaration, final BodyDeclaration newDeclaration) {
	final Javadoc predecessor= oldDeclaration.getJavadoc();
	if (predecessor != null) {
		String newString= ASTNodes.getNodeSource(predecessor, false, true);
		if (newString != null) {
			newDeclaration.setJavadoc((Javadoc) rewrite.createStringPlaceholder(newString, ASTNode.JAVADOC));
		}
	}
}
Example 4
Source File: JavadocTagsSubProcessor.java    From eclipse.jdt.ls with Eclipse Public License 2.0 4 votes vote down vote up 
public static void getMissingJavadocTagProposals(IInvocationContext context, IProblemLocationCore problem, Collection<ChangeCorrectionProposal> proposals) {
	ASTNode node= problem.getCoveringNode(context.getASTRoot());
	if (node == null) {
		return;
	}
	node= ASTNodes.getNormalizedNode(node);

	BodyDeclaration bodyDeclaration= ASTResolving.findParentBodyDeclaration(node);
	if (bodyDeclaration == null) {
		return;
	}
	Javadoc javadoc= bodyDeclaration.getJavadoc();
	if (javadoc == null) {
		return;
	}

	String label;
	StructuralPropertyDescriptor location= node.getLocationInParent();
	if (location == SingleVariableDeclaration.NAME_PROPERTY) {
		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_paramtag_description;
		if (node.getParent().getLocationInParent() != MethodDeclaration.PARAMETERS_PROPERTY) {
			return; // paranoia checks
		}
	} else if (location == TypeParameter.NAME_PROPERTY) {
		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_paramtag_description;
		StructuralPropertyDescriptor parentLocation= node.getParent().getLocationInParent();
		if (parentLocation != MethodDeclaration.TYPE_PARAMETERS_PROPERTY && parentLocation != TypeDeclaration.TYPE_PARAMETERS_PROPERTY) {
			return; // paranoia checks
		}
	} else if (location == MethodDeclaration.RETURN_TYPE2_PROPERTY) {
		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_returntag_description;
	} else if (location == MethodDeclaration.THROWN_EXCEPTION_TYPES_PROPERTY) {
		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_throwstag_description;
	} else {
		return;
	}
	ASTRewriteCorrectionProposal proposal= new AddMissingJavadocTagProposal(label, context.getCompilationUnit(), bodyDeclaration, node, IProposalRelevance.ADD_MISSING_TAG);
	proposals.add(proposal);

	String label2= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_allmissing_description;
	ASTRewriteCorrectionProposal addAllMissing= new AddAllMissingJavadocTagsProposal(label2, context.getCompilationUnit(), bodyDeclaration, IProposalRelevance.ADD_ALL_MISSING_TAGS);
	proposals.add(addAllMissing);
}
Example 5
Source File: JavadocTagsSubProcessor.java    From Eclipse-Postfix-Code-Completion with Eclipse Public License 1.0 4 votes vote down vote up 
public static void getMissingJavadocTagProposals(IInvocationContext context, IProblemLocation problem, Collection<ICommandAccess> proposals) {
 	ASTNode node= problem.getCoveringNode(context.getASTRoot());
 	if (node == null) {
 		return;
 	}
 	node= ASTNodes.getNormalizedNode(node);

 	BodyDeclaration bodyDeclaration= ASTResolving.findParentBodyDeclaration(node);
 	if (bodyDeclaration == null) {
 		return;
 	}
 	Javadoc javadoc= bodyDeclaration.getJavadoc();
 	if (javadoc == null) {
 		return;
 	}

 	String label;
 	StructuralPropertyDescriptor location= node.getLocationInParent();
 	if (location == SingleVariableDeclaration.NAME_PROPERTY) {
 		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_paramtag_description;
 		if (node.getParent().getLocationInParent() != MethodDeclaration.PARAMETERS_PROPERTY) {
 			return; // paranoia checks
 		}
 	} else if (location == TypeParameter.NAME_PROPERTY) {
 		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_paramtag_description;
 		StructuralPropertyDescriptor parentLocation= node.getParent().getLocationInParent();
 		if (parentLocation != MethodDeclaration.TYPE_PARAMETERS_PROPERTY && parentLocation != TypeDeclaration.TYPE_PARAMETERS_PROPERTY) {
 			return; // paranoia checks
 		}
 	} else if (location == MethodDeclaration.RETURN_TYPE2_PROPERTY) {
 		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_returntag_description;
	} else if (location == MethodDeclaration.THROWN_EXCEPTION_TYPES_PROPERTY) {
 		label= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_throwstag_description;
 	} else {
 		return;
 	}
 	ASTRewriteCorrectionProposal proposal= new AddMissingJavadocTagProposal(label, context.getCompilationUnit(), bodyDeclaration, node, IProposalRelevance.ADD_MISSING_TAG);
 	proposals.add(proposal);

 	String label2= CorrectionMessages.JavadocTagsSubProcessor_addjavadoc_allmissing_description;
 	ASTRewriteCorrectionProposal addAllMissing= new AddAllMissingJavadocTagsProposal(label2, context.getCompilationUnit(), bodyDeclaration, IProposalRelevance.ADD_ALL_MISSING_TAGS);
 	proposals.add(addAllMissing);
}