Se agrega documentación sobre los servidores.

[mecon/scripts.git] / code2xmi / README

diff --git a/code2xmi/README b/code2xmi/README
index 0b17994c548f748e7b4d34001dbb4128c78493eb..2626ab4c04a4c0477b451ec6aff4e0b397ec3eb4 100644 (file)
--- a/code2xmi/README
+++ b/code2xmi/README
@@ -4,8 +4,19 @@ CODE2XMI
 Script that parse a php file and creates from it the classes (with its
 attributes and functions) that are in the file.
 
-This script generates a light xmi file. This xmi file will include all the
-classes, the functions and the attributes that are content in the php file.
+This file will receive a directory or a list of archives as argument.
+The directory search is not recursive so if you want to parse it recursively 
+you may use the find command to solve this.
+Example: ./code2xmi HTMl/
+Example: ./code2xmi Table.php Form.php etc
+Example: ./code2xmi `find HTML/ -name '*.php'`
+
+The output will be a single file named umlOut.xmi and it will be generated in 
+the same path were the script was run.
+
+This script generates a light xmi file (Class only no diagrams will be 
+generated). This xmi file will include all the classes, the functions and the 
+attributes that are content in the php file.
 All the documentation that belongs to a class or a function or an attribute is 
 attached to it in the corresponding xmi line, so when you open the xmi file you
 will have your object with all the information that matters.
@@ -33,3 +44,4 @@ Example of a wrong line: function parseParenthesis( param1,
 This line must be written this way: 
 function parseParenthesis(param1, param2=null)
 
+For a complete example you may check the Tabla.php archive.