Coding Style

[mirror_edk2.git] / Tools / Java / Source / MigrationTools / org / tianocore / migration / MigrationTool.java

diff --git a/Tools/Java/Source/MigrationTools/org/tianocore/migration/MigrationTool.java b/Tools/Java/Source/MigrationTools/org/tianocore/migration/MigrationTool.java
index 7ed4113ad4014276d7c63c9555bc6339f9be0048..c65a425df4d6789547f2d1783be4eb2bf9f572f8 100644 (file)
--- a/Tools/Java/Source/MigrationTools/org/tianocore/migration/MigrationTool.java
+++ b/Tools/Java/Source/MigrationTools/org/tianocore/migration/MigrationTool.java
@@ -116,13 +116,19 @@ public class MigrationTool {
         * This method designates the location of temp directory.\r
         * \r
         * @param modulepath\r
-        * @return\r
+        * @return String\r
         */\r
        public static final String getTempDir(String modulepath) {\r
                return "C:" + File.separator + "MigrationTool_Temp"\r
                                + modulepath.replace(startpath, "");\r
        }\r
 \r
+       /**\r
+        * This method is the default output path generating scheme.\r
+        * \r
+        * @param inputpath\r
+        * @return String\r
+        */\r
        private static final String assignOutPutPath(String inputpath) {\r
                if (MigrationTool.defaultoutput) {\r
                        return inputpath.replaceAll(Common.STRSEPARATER, "$1");\r
@@ -133,6 +139,14 @@ public class MigrationTool {
                }\r
        }\r
 \r
+       /**\r
+        * This function is called by main loop of the MigrationTool which\r
+        * verifies whether a dir contains a module, thus generating a map\r
+        * which shows the corresponding path for each module.\r
+        * \r
+        * @param filepath\r
+        * @throws Exception\r
+        */\r
        public static final void seekModule(String filepath) throws Exception {\r
                if (ModuleInfo.isModule(filepath)) {\r
                        ModuleInfoMap.put(new ModuleInfo(filepath),\r
@@ -140,6 +154,12 @@ public class MigrationTool {
                }\r
        }\r
 \r
+       /**\r
+        * This is the main loop of the tool.\r
+        * \r
+        * @param path\r
+        * @throws Exception\r
+        */\r
        public static final void startMigrateAll(String path) throws Exception {\r
                startpath = path;\r
                MigrationTool.ui.println("Project Migration");\r
@@ -162,8 +182,14 @@ public class MigrationTool {
                Common.deleteDir("C:" + File.separator + "MigrationTool_Temp");\r
        }\r
 \r
+       /**\r
+        * This main method initializes the environment. \r
+        * \r
+        * @param args\r
+        * @throws Exception\r
+        */\r
        public static void main(String[] args) throws Exception {\r
                ui = FirstPanel.getInstance();\r
                db = Database.getInstance();\r
        }\r
-}\r
+}
\ No newline at end of file