X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=Tools%2FSource%2FGenBuild%2Forg%2Ftianocore%2Fbuild%2Fid%2FPackageIdentification.java;h=cb0b2a09c0572f0b72bed1588e5552cb6e5ce85b;hp=815fd445288155b235e745ee94864c26bbf02f1c;hb=01413f0ccb4e678f633c42d300a1eced780a22d5;hpb=802e005517d1c21865c5d50c0933abc8289ea5de

diff --git a/Tools/Source/GenBuild/org/tianocore/build/id/PackageIdentification.java b/Tools/Source/GenBuild/org/tianocore/build/id/PackageIdentification.java
index 815fd44528..cb0b2a09c0 100644
--- a/Tools/Source/GenBuild/org/tianocore/build/id/PackageIdentification.java
+++ b/Tools/Source/GenBuild/org/tianocore/build/id/PackageIdentification.java
@@ -16,35 +16,69 @@ import java.io.File;
 
 import org.tianocore.build.global.GlobalData;
 
+/**
+  This class is used to identify a package. 
+
+  @since GenBuild 1.0
+**/
 public class PackageIdentification extends Identification{
     
     //
-    // It is optional
+    // SPD file
     //
     private File spdFile;
     
+    /**
+      @param guid Guid
+      @param version Version
+    **/
     public PackageIdentification(String guid, String version){
         super(guid, version);
     }
     
+    /**
+      @param name Name
+      @param guid Guid
+      @param version Version
+    **/
     public PackageIdentification(String name, String guid, String version){
         super(name, guid, version);
     }
     
+    /**
+      @param name Name
+      @param guid Guid
+      @param version Version
+      @param spdFilename SPD file name
+    **/
     public PackageIdentification(String name, String guid, String version, String spdFilename){
         super(name, guid, version);
         this.spdFile = new File(spdFilename);
     }
     
+    /**
+      @param name Name
+      @param guid Guid
+      @param version Version
+      @param spdFile SPD file
+    **/
     public PackageIdentification(String name, String guid, String version, File spdFile){
         super(name, guid, version);
         this.spdFile = spdFile;
     }
     
+    /**
+      set SPD file.
+      @param spdFile SPD file
+    **/
     public void setSpdFile(File spdFile) {
         this.spdFile = spdFile;
     }
 
+    /**
+      get SPD file
+      @return SPD file
+    **/
     public File getSpdFile() {
         return spdFile;
     }
@@ -61,11 +95,19 @@ public class PackageIdentification extends Identification{
         }
     }
     
+    /**
+      get package directory
+      @return Package Directory
+    **/
     public String getPackageDir(){
         prepareSpdFile();
         return spdFile.getParent();
     }
     
+    /**
+      get package relative directory. 
+      @return package relative directory
+    **/
     public String getPackageRelativeDir(){
         prepareSpdFile();
         String relativeDir =spdFile.getParent().substring(GlobalData.getWorkspacePath().length());