From dae72336d22d2f1e595dccdda5e5a1c57e222b03 Mon Sep 17 00:00:00 2001 From: Roman Shevchenko Date: Thu, 3 Dec 2015 22:40:49 +0100 Subject: [PATCH] Cleanup (javadoc; annotations) --- .../com/intellij/openapi/project/Project.java | 20 +++++++------------ .../ide/highlighter/ProjectFileType.java | 11 +++++----- 2 files changed, 12 insertions(+), 19 deletions(-) diff --git a/platform/core-api/src/com/intellij/openapi/project/Project.java b/platform/core-api/src/com/intellij/openapi/project/Project.java index 258f315365d0..a3ff009226a6 100644 --- a/platform/core-api/src/com/intellij/openapi/project/Project.java +++ b/platform/core-api/src/com/intellij/openapi/project/Project.java @@ -18,22 +18,21 @@ package com.intellij.openapi.project; import com.intellij.openapi.components.ComponentManager; import com.intellij.openapi.extensions.AreaInstance; import com.intellij.openapi.vfs.VirtualFile; -import org.jetbrains.annotations.NonNls; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; /** - * An object representing IntelliJ project.
+ * An object representing an IntelliJ project. * - *
  • To get all its modules, use {@link com.intellij.openapi.module.ModuleManager#getModules()}
    + *

    To get all of its modules, use {@code ModuleManager.getInstance(project).getModules()}. * - *

  • To iterate over all project source files and directories, use {@code com.intellij.openapi.roots.ProjectFileIndex.SERVICE.getInstance(project).iterateContent(iterator)}
    - * - *
  • To get the list of all open projects, use {@link com.intellij.openapi.project.ProjectManager#getOpenProjects()} + *

    To iterate over all project source files and directories, + * use {@code ProjectFileIndex.SERVICE.getInstance(project).iterateContent(iterator)}. * + *

    To get the list of all open projects, use {@code ProjectManager.getInstance().getOpenProjects()}. */ public interface Project extends ComponentManager, AreaInstance { - @NonNls String DIRECTORY_STORE_FOLDER = ProjectCoreUtil.DIRECTORY_BASED_PROJECT_DIR; + String DIRECTORY_STORE_FOLDER = ProjectCoreUtil.DIRECTORY_BASED_PROJECT_DIR; /** * Returns a name ot the project. For a directory-based project it's an arbitrary string specified by user at project creation @@ -42,7 +41,6 @@ public interface Project extends ComponentManager, AreaInstance { * @return project name */ @NotNull - @NonNls String getName(); /** @@ -60,7 +58,6 @@ public interface Project extends ComponentManager, AreaInstance { * @return a path to a project base directory, or null for default project */ @Nullable - @NonNls String getBasePath(); /** @@ -80,7 +77,6 @@ public interface Project extends ComponentManager, AreaInstance { * @return a system-independent path to project file (see {@linkplain #getProjectFile()}) or null for default project. */ @Nullable - @NonNls String getProjectFilePath(); /** @@ -92,7 +88,6 @@ public interface Project extends ComponentManager, AreaInstance { * @return presentable project path */ @Nullable - @NonNls String getPresentableUrl(); /** @@ -109,7 +104,6 @@ public interface Project extends ComponentManager, AreaInstance { VirtualFile getWorkspaceFile(); @NotNull - @NonNls String getLocationHash(); void save(); @@ -119,4 +113,4 @@ public interface Project extends ComponentManager, AreaInstance { boolean isInitialized(); boolean isDefault(); -} +} \ No newline at end of file diff --git a/platform/projectModel-api/src/com/intellij/ide/highlighter/ProjectFileType.java b/platform/projectModel-api/src/com/intellij/ide/highlighter/ProjectFileType.java index 4988159d68b9..fd3250f968d5 100644 --- a/platform/projectModel-api/src/com/intellij/ide/highlighter/ProjectFileType.java +++ b/platform/projectModel-api/src/com/intellij/ide/highlighter/ProjectFileType.java @@ -1,5 +1,5 @@ /* - * Copyright 2000-2014 JetBrains s.r.o. + * 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. @@ -20,7 +20,6 @@ import com.intellij.ide.IdeBundle; import com.intellij.openapi.fileTypes.InternalFileType; import com.intellij.openapi.vfs.CharsetToolkit; import com.intellij.openapi.vfs.VirtualFile; -import org.jetbrains.annotations.NonNls; import org.jetbrains.annotations.NotNull; import javax.swing.*; @@ -28,10 +27,10 @@ import javax.swing.*; public class ProjectFileType implements InternalFileType { public static final ProjectFileType INSTANCE = new ProjectFileType(); - @NonNls public static final String DEFAULT_EXTENSION = "ipr"; - @NonNls public static final String DOT_DEFAULT_EXTENSION = ".ipr"; + public static final String DEFAULT_EXTENSION = "ipr"; + public static final String DOT_DEFAULT_EXTENSION = ".ipr"; - private ProjectFileType() {} + private ProjectFileType() { } @Override @NotNull @@ -70,4 +69,4 @@ public class ProjectFileType implements InternalFileType { public String getCharset(@NotNull VirtualFile file, @NotNull final byte[] content) { return CharsetToolkit.UTF8; } -} +} \ No newline at end of file