From: Yann Cébron Date: Wed, 12 Aug 2020 15:16:00 +0000 (+0200) Subject: ProcessCanceledException: cleanup javadoc X-Git-Tag: idea/203.3645.34~2277^2~739 X-Git-Url: https://git.jetbrains.org/?p=idea%2Fcommunity.git;a=commitdiff_plain;h=6caaad7de210713fdcac979f563699358eb0ae2e ProcessCanceledException: cleanup javadoc GitOrigin-RevId: a9ee63763984e9ac55ca409bc77dbc47d8a2a28d --- diff --git a/platform/util/src/com/intellij/openapi/progress/ProcessCanceledException.java b/platform/util/src/com/intellij/openapi/progress/ProcessCanceledException.java index e2b7d83d21f9..9c331acbece5 100644 --- a/platform/util/src/com/intellij/openapi/progress/ProcessCanceledException.java +++ b/platform/util/src/com/intellij/openapi/progress/ProcessCanceledException.java @@ -1,18 +1,4 @@ -/* - * Copyright 2000-2015 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-2020 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.openapi.progress; import com.intellij.openapi.diagnostic.ControlFlowException; @@ -20,11 +6,15 @@ import org.jetbrains.annotations.Nullable; /** * An exception indicating that the currently running operation was terminated and should finish as soon as possible. - * Normally this exception should not be caught, swallowed, logged or handled in any way. - * It should be rethrown so that the infrastructure could handle it correctly. + *

+ * Usually, this exception should not be caught, swallowed, logged, or handled in any way. + * Instead, it should be rethrown so that the infrastructure can handle it correctly. + *

+ *

* This exception can happen during almost any IDE activity, e.g. any PSI query, * {@link com.intellij.openapi.extensions.ExtensionPointName#getExtensions}, - * {@link com.intellij.openapi.actionSystem.AnAction#update}, etc.

+ * {@link com.intellij.openapi.actionSystem.AnAction#update}, etc. + *

* * @see com.intellij.openapi.progress.ProgressIndicator#checkCanceled() * @see General Threading Rules