From c6d73caa6be3dbdde738c147f755af533112eb2d Mon Sep 17 00:00:00 2001 From: Roman Shevchenko Date: Wed, 14 Sep 2011 13:28:54 +0200 Subject: [PATCH] Typos, javadoc --- .../src/com/intellij/psi/PsiAnnotation.java | 26 +++++++++++-------- .../com/intellij/psi/PsiAnnotationOwner.java | 10 ++++--- 2 files changed, 21 insertions(+), 15 deletions(-) diff --git a/java/openapi/src/com/intellij/psi/PsiAnnotation.java b/java/openapi/src/com/intellij/psi/PsiAnnotation.java index 585671eb666b..3ef8b31ece92 100644 --- a/java/openapi/src/com/intellij/psi/PsiAnnotation.java +++ b/java/openapi/src/com/intellij/psi/PsiAnnotation.java @@ -1,5 +1,5 @@ /* - * Copyright 2000-2009 JetBrains s.r.o. + * Copyright 2000-2011 JetBrains s.r.o. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -53,7 +53,8 @@ public interface PsiAnnotation extends PsiAnnotationMemberValue, PsiMetaOwner { * * @return the class name, or null if the annotation is unresolved. */ - @Nullable @NonNls + @Nullable + @NonNls String getQualifiedName(); /** @@ -68,33 +69,36 @@ public interface PsiAnnotation extends PsiAnnotationMemberValue, PsiMetaOwner { * Returns the value of the annotation element with the specified name. * * @param attributeName name of the annotation element for which the value is requested. If it isn't defined in annotation, tha default - * value is returned. + * value is returned. * @return the element value, or null if the annotation does not contain a value for - * the element and the element has no default value. + * the element and the element has no default value. */ @Nullable PsiAnnotationMemberValue findAttributeValue(@NonNls String attributeName); - /** + /** * Returns the value of the annotation element with the specified name. * * @param attributeName name of the annotation element for which the value is requested, declared in this annotation. * @return the element value, or null if the annotation does not contain a value for - * the element. + * the element. */ @Nullable PsiAnnotationMemberValue findDeclaredAttributeValue(@NonNls String attributeName); /** * Set annotation attribute value. Adds new name-value pair or uses an existing one, expands unnamed 'value' attribute name if needed. + * * @param attributeName attribute name - * @param value new value template element + * @param value new value template element + * @return new declared attribute value */ T setDeclaredAttributeValue(@NonNls String attributeName, @Nullable T value); - - - - // in case of type annotation the owner might be type element, not the parent + /** + * Returns an owner of the annotation - usually a parent, but for type annotations the owner might be a type element. + * + * @return annotation owner + */ PsiAnnotationOwner getOwner(); } diff --git a/java/openapi/src/com/intellij/psi/PsiAnnotationOwner.java b/java/openapi/src/com/intellij/psi/PsiAnnotationOwner.java index 319223bfd6ce..086b28c5b959 100644 --- a/java/openapi/src/com/intellij/psi/PsiAnnotationOwner.java +++ b/java/openapi/src/com/intellij/psi/PsiAnnotationOwner.java @@ -1,5 +1,5 @@ /* - * Copyright 2000-2009 JetBrains s.r.o. + * Copyright 2000-2011 JetBrains s.r.o. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -34,9 +34,10 @@ public interface PsiAnnotationOwner { /** * @return the list of annotations which are applicable to this owner. - * E.g. Type annotations on method belong to its type element, not the method. + * E.g. Type annotations on method belong to its type element, not the method. */ - @NotNull PsiAnnotation[] getApplicableAnnotations(); + @NotNull + PsiAnnotation[] getApplicableAnnotations(); /** * Searches the modifier list for an annotation with the specified fully qualified name @@ -49,7 +50,8 @@ public interface PsiAnnotationOwner { PsiAnnotation findAnnotation(@NotNull @NonNls String qualifiedName); /** - * Add a new annotation to this modifier list. The annotation class name will be shortened. No attribbutes will be defined. + * Add a new annotation to this modifier list. The annotation class name will be shortened. No attributes will be defined. + * * @param qualifiedName qualifiedName * @return newly added annotation */