StartupActivity: javadoc cleanup

GitOrigin-RevId: 6ef8047e179663c997f984f42c8b5d552662fcea
This commit is contained in:
Yann Cébron
2022-04-14 09:13:23 +00:00
committed by intellij-monorepo-bot
parent 588475ba7c
commit f89cf0ec10
@@ -1,4 +1,4 @@
// Copyright 2000-2021 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.
// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.openapi.startup;
import com.intellij.ide.util.RunOnceUtil;
@@ -8,19 +8,18 @@ import org.jetbrains.annotations.NotNull;
/**
* Runs an activity on project open.
* <p>
* If activity implements {@link com.intellij.openapi.project.DumbAware}, it is executed after project is opened
* on a background thread with no visible progress indicator. Otherwise, it is executed on EDT when indexes are ready.
* </p>
* <p>
* See <a href="https://github.com/JetBrains/intellij-community/blob/master/platform/service-container/overview.md#startup-activity">docs</a> for details.
*
* @see StartupManager
* @see RunOnceUtil
*/
public interface StartupActivity {
/**
* If activity implements {@link com.intellij.openapi.project.DumbAware}, it is executed after project is opened
* on a background thread with no visible progress indicator. Otherwise, it is executed on EDT when indexes are ready.
*
* @see StartupManager#registerPostStartupActivity
* @see DumbAware
*/
ExtensionPointName<StartupActivity> POST_STARTUP_ACTIVITY = new ExtensionPointName<>("com.intellij.postStartupActivity");
void runActivity(@NotNull Project project);
@@ -28,9 +27,12 @@ public interface StartupActivity {
/**
* Represents a startup activity that should be executed before {@link com.intellij.openapi.project.DumbService} switches to the "smart mode".
*/
interface RequiredForSmartMode extends StartupActivity { }
interface RequiredForSmartMode extends StartupActivity {
}
interface DumbAware extends StartupActivity, com.intellij.openapi.project.DumbAware { }
interface DumbAware extends StartupActivity, com.intellij.openapi.project.DumbAware {
}
interface Background extends StartupActivity, com.intellij.openapi.project.DumbAware { }
interface Background extends StartupActivity, com.intellij.openapi.project.DumbAware {
}
}