MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-01-07 05:09:37 +07:00
Code Issues Packages Projects Releases Wiki Activity

option to ignore simple getters/setters: off by default as private fields by default do not require javadoc (IDEA-43830)

Browse Source
This commit is contained in:
anna
2013-04-17 18:14:04 +02:00
parent 2c34966c72
commit 2a94c547e7
4 changed files with 57 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
java/java-impl/src/com/intellij/codeInspection/javaDoc/JavaDocLocalInspection.java
View File

@@ -26,6 +26,7 @@ import com.intellij.psi.impl.source.jsp.jspJava.JspClass;
import com.intellij.psi.impl.source.jsp.jspJava.JspHolderMethod;
import com.intellij.psi.javadoc.*;
import com.intellij.psi.util.InheritanceUtil;
import com.intellij.psi.util.PropertyUtil;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.ui.DocumentAdapter;
import com.intellij.ui.FieldPanel;
@@ -70,6 +71,7 @@ public class JavaDocLocalInspection extends BaseLocalInspectionTool {
ourUniqueTags.add("serialData");
}
private static final String IGNORE_ACCESSORS_ATTR_NAME = "IGNORE_ACCESSORS";
public static class Options implements JDOMExternalizable {
@NonNls public String ACCESS_JAVADOC_REQUIRED_FOR = NONE;
@@ -103,6 +105,11 @@ public class JavaDocLocalInspection extends BaseLocalInspectionTool {
public String myAdditionalJavadocTags = "";
private boolean myIgnoreEmptyDescriptions = false;
private boolean myIgnoreSimpleAccessors = false;
public void setIgnoreSimpleAccessors(boolean ignoreSimpleAccessors) {
myIgnoreSimpleAccessors = ignoreSimpleAccessors;
}
private static final Logger LOG = Logger.getInstance("com.intellij.codeInspection.javaDoc.JavaDocLocalInspection");
@@ -266,6 +273,13 @@ public class JavaDocLocalInspection extends BaseLocalInspectionTool {
}
});
add(ignorePointToItselfCheckBox, gc);
final JCheckBox ignoreSimpleAccessorsCheckBox = new JCheckBox("Ignore simple property accessors", myIgnoreSimpleAccessors);
ignoreSimpleAccessorsCheckBox.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
myIgnoreSimpleAccessors = ignoreSimpleAccessorsCheckBox.isSelected();
}
});
add(ignoreSimpleAccessorsCheckBox, gc);
}
public FieldPanel createAdditionalJavadocTagsPanel(){
@@ -294,6 +308,25 @@ public class JavaDocLocalInspection extends BaseLocalInspectionTool {
return new OptionsPanel();
}
@Override
public void writeSettings(Element node) throws WriteExternalException {
super.writeSettings(node);
if (myIgnoreSimpleAccessors) {
final Element option = new Element(IGNORE_ACCESSORS_ATTR_NAME);
option.setAttribute("value", String.valueOf(true));
node.addContent(option);
}
}
@Override
public void readSettings(Element node) throws InvalidDataException {
super.readSettings(node);
final Element ignoreAccessorsTag = node.getChild(IGNORE_ACCESSORS_ATTR_NAME);
if (ignoreAccessorsTag != null) {
myIgnoreSimpleAccessors = Boolean.parseBoolean(ignoreAccessorsTag.getAttributeValue("value"));
}
}
private static ProblemDescriptor createDescriptor(@NotNull PsiElement element, String template, InspectionManager manager,
boolean onTheFly) {
return manager.createProblemDescriptor(element, template, onTheFly, (LocalQuickFix [])null, ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
@@ -507,6 +540,9 @@ public class JavaDocLocalInspection extends BaseLocalInspectionTool {
if (IGNORE_DEPRECATED && (psiMethod.isDeprecated() || psiMethod.getContainingClass().isDeprecated())) {
return null;
}
if (myIgnoreSimpleAccessors && PropertyUtil.isSimplePropertyAccessor(psiMethod)) {
return null;
}
PsiDocComment docComment = psiMethod.getDocComment();
final PsiMethod[] superMethods = psiMethod.findSuperMethods();
final boolean required = isJavaDocRequired(psiMethod);

4
java/java-tests/testData/inspection/javaDocInspection/ignoreAccessors/expected.xml Normal file
View File

@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<problems>
</problems>

11
java/java-tests/testData/inspection/javaDocInspection/ignoreAccessors/src/Test.java Normal file
View File

@@ -0,0 +1,11 @@
public class Test {
private int myFoo;
public int getFoo() {
return myFoo;
}
public void setFoo(int foo) {
myFoo = foo;
}
}

6
java/java-tests/testSrc/com/intellij/codeInspection/JavaDocInspectionTest.java
View File

@@ -64,4 +64,10 @@ public class JavaDocInspectionTest extends InspectionTestCase {
inspection.IGNORE_DUPLICATED_THROWS = true;
doTest("javaDocInspection/" + getTestName(true), inspection);
}
public void testIgnoreAccessors() throws Exception {
final JavaDocLocalInspection inspection = new JavaDocLocalInspection();
inspection.setIgnoreSimpleAccessors(true);
doTest("javaDocInspection/" + getTestName(true), inspection);
}
}