javadoc tweaks

This commit is contained in:
Bas Leijdekkers
2019-03-08 11:32:41 +01:00
parent 2a7d38f141
commit 5316bb28d3
3 changed files with 12 additions and 54 deletions
@@ -1,25 +1,11 @@
/*
* Copyright 2000-2009 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.psi;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Represents an array access expession, for example, {@code i [1]}.
* Represents an array access expression, for example, {@code a[1]}.
*/
public interface PsiArrayAccessExpression extends PsiExpression {
/**
@@ -33,7 +19,7 @@ public interface PsiArrayAccessExpression extends PsiExpression {
/**
* Returns the index expression (the expression in square brackets).
*
* @return the index expression, or null if the array access expression is incomplete.
* @return the index expression, or {@code null} if the array access expression is incomplete.
*/
@Nullable
PsiExpression getIndexExpression();
@@ -1,18 +1,4 @@
/*
* Copyright 2000-2009 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.psi;
import org.jetbrains.annotations.Nullable;
@@ -24,7 +10,7 @@ public interface PsiAssertStatement extends PsiStatement{
/**
* Returns the expression representing the asserted condition.
*
* @return the asserted conditione expression, or null if the assert statement
* @return the asserted condition expression, or {@code null} if the assert statement
* is incomplete.
*/
@Nullable
@@ -33,7 +19,7 @@ public interface PsiAssertStatement extends PsiStatement{
/**
* Returns the expression representing the description of the assert.
*
* @return the assert description expression, or null if none has been specified.
* @return the assert description expression, or {@code null} if none has been specified.
*/
@Nullable
PsiExpression getAssertDescription();
@@ -1,18 +1,4 @@
/*
* Copyright 2000-2009 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.psi;
import org.jetbrains.annotations.Nullable;
@@ -24,7 +10,7 @@ public interface PsiForStatement extends PsiLoopStatement{
/**
* Returns the initialization part of the statement.
*
* @return the initialization part, or null if the statement is incomplete.
* @return the initialization part, or {@code null} if the statement is incomplete.
*/
@Nullable
PsiStatement getInitialization();
@@ -32,7 +18,7 @@ public interface PsiForStatement extends PsiLoopStatement{
/**
* Returns the condition part of the statement.
*
* @return the condition part, or null if the statement is incomplete.
* @return the condition part, or {@code null} if no condition has been specified.
*/
@Nullable
PsiExpression getCondition();
@@ -40,7 +26,7 @@ public interface PsiForStatement extends PsiLoopStatement{
/**
* Returns the update part of the statement.
*
* @return the update part, or null if the statement is incomplete.
* @return the update part, or {@code null} if no update has been specified.
*/
@Nullable
PsiStatement getUpdate();
@@ -48,7 +34,7 @@ public interface PsiForStatement extends PsiLoopStatement{
/**
* Returns the opening parenthesis enclosing the statement header.
*
* @return the opening parenthesis, or null if the statement is incomplete.
* @return the opening parenthesis, or {@code null} if the statement is incomplete.
*/
@Nullable
PsiJavaToken getLParenth();
@@ -56,7 +42,7 @@ public interface PsiForStatement extends PsiLoopStatement{
/**
* Returns the closing parenthesis enclosing the statement header.
*
* @return the closing parenthesis, or null if the statement is incomplete.
* @return the closing parenthesis, or {@code null} if the statement is incomplete.
*/
@Nullable
PsiJavaToken getRParenth();