Remove some unused code and adjust some code format. Modules build with FPD sequence...

[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / id / PlatformIdentification.java

diff --git a/Tools/Source/GenBuild/org/tianocore/build/id/PlatformIdentification.java b/Tools/Source/GenBuild/org/tianocore/build/id/PlatformIdentification.java
index c5c2f1e03040c198961719e1299f465df9d1ad3f..7c669652b8750dce94a0d6f691b77743f41705ae 100644 (file)
--- a/Tools/Source/GenBuild/org/tianocore/build/id/PlatformIdentification.java
+++ b/Tools/Source/GenBuild/org/tianocore/build/id/PlatformIdentification.java
@@ -16,23 +16,52 @@ import java.io.File;
 \r
 import org.tianocore.build.global.GlobalData;\r
 \r
+/**\r
+  This class is used to identify a platform. \r
+\r
+  @since GenBuild 1.0\r
+**/\r
 public class PlatformIdentification extends Identification{\r
     \r
+    ///\r
+    /// FPD file\r
+    ///\r
     private File fpdFile;\r
     \r
+    /**\r
+      @param guid Guid\r
+      @param version Version\r
+    **/\r
     public PlatformIdentification(String guid, String version){\r
         super(guid, version);\r
     }\r
     \r
+    /**\r
+      @param name Name\r
+      @param guid Guid\r
+      @param version Version\r
+    **/\r
     public PlatformIdentification(String name, String guid, String version){\r
         super(name, guid, version);\r
     }\r
     \r
+    /**\r
+      @param name Name\r
+      @param guid Guid\r
+      @param version Version\r
+      @param fpdFilename Fpd File Name\r
+    **/\r
     public PlatformIdentification(String name, String guid, String version, String fpdFilename){\r
         super(name, guid, version);\r
         this.fpdFile = new File(fpdFilename);\r
     }\r
     \r
+    /**\r
+      @param name Name\r
+      @param guid Guid\r
+      @param version Version\r
+      @param fpdFile Fpd File\r
+    **/\r
     public PlatformIdentification(String name, String guid, String version, File fpdFile){\r
         super(name, guid, version);\r
         this.fpdFile = fpdFile;\r
@@ -42,14 +71,26 @@ public class PlatformIdentification extends Identification{
         return "Platform " + name + "["+guid+"]";\r
     }\r
 \r
+    /**\r
+     Set FPD file. \r
+      @param fpdFile FPD File\r
+    **/\r
     public void setFpdFile(File fpdFile) {\r
         this.fpdFile = fpdFile;\r
     }\r
 \r
+    /**\r
+      Get FPD file. \r
+      @return Fpd File\r
+    **/\r
     public File getFpdFile() {\r
         return fpdFile;\r
     }\r
     \r
+    /**\r
+      Get FPD relative file to workspace. \r
+      @return Fpd Relative file. \r
+    **/\r
     public String getRelativeFpdFile (){\r
         String relativeDir = fpdFile.getPath().substring(GlobalData.getWorkspacePath().length());\r
         if(relativeDir.startsWith("\\") || relativeDir.startsWith("/")) {\r
@@ -58,6 +99,10 @@ public class PlatformIdentification extends Identification{
         return relativeDir;\r
     }\r
     \r
+    /**\r
+      Get Platform relative directory to workspace. \r
+      @return Platform relative directory\r
+    **/\r
     public String getPlatformRelativeDir(){\r
         String relativeDir = fpdFile.getParent().substring(GlobalData.getWorkspacePath().length());\r
         if(relativeDir.startsWith("\\") || relativeDir.startsWith("/")) {\r