MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup (javadoc; annotations)

Browse Source
This commit is contained in:
Roman Shevchenko
2015-12-03 23:00:45 +01:00
parent a08b984bf8
commit dae72336d2
2 changed files with 12 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/core-api/src/com/intellij/openapi/project/Project.java
+7 -13
View File
@@ -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.<br/>
* An object representing an IntelliJ project.
*
* <li/>To get all its modules, use {@link com.intellij.openapi.module.ModuleManager#getModules()}<br/>
* <p>To get all of its modules, use {@code ModuleManager.getInstance(project).getModules()}.
*
* <li/>To iterate over all project source files and directories, use {@code com.intellij.openapi.roots.ProjectFileIndex.SERVICE.getInstance(project).iterateContent(iterator)}<br/>
*
* <li/>To get the list of all open projects, use {@link com.intellij.openapi.project.ProjectManager#getOpenProjects()}
* <p>To iterate over all project source files and directories,
* use {@code ProjectFileIndex.SERVICE.getInstance(project).iterateContent(iterator)}.
*
* <p>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 <code>null</code> 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 <code>null</code> 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();
}
}
platform/projectModel-api/src/com/intellij/ide/highlighter/ProjectFileType.java
+5 -6
View File
@@ -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;
}
}
}