PathMacros: more javadocs
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / application / PathMacros.java
index fac4e5e9edb14ec2d5ec88bf91b7df37661255fa..17681c6b270f481a32c5ae7fdd6e1d381ef38ecf 100644 (file)
@@ -21,6 +21,14 @@ import org.jetbrains.annotations.NotNull;
 import java.util.Collection;
 import java.util.Set;
 
+/**
+ * Stores predefined and custom (user-defined) path variables. Path variables are used to convert paths from absolute to portable form and
+ * vice versa. It allows us to reuse project configuration files on different machines.
+ * <p>
+ * In order to make a path (or URL) portable the serialization subsystem replaces its prefix by name of a corresponding path variable.
+ * There are {@link #getSystemMacroNames() predefined path variables} and also it's possible to specify {@link #getUserMacroNames() custom path variables}.
+ * </p>
+ */
 public abstract class PathMacros {
   public static PathMacros getInstance() {
     return ServiceManager.getService(PathMacros.class);