code2xmi/README

   1 CODE2XMI
   2 --------
   3
   4 Script that parse a php file and creates from it the classes (with its
   5 attributes and functions) that are in the file.
   6
   7 This file will receive a directory or a list of archives as argument.
   8 The directory search is not recursive so if you want to parse it recursively
   9 you may use the find command to solve this.
  10 Example: ./code2xmi HTMl/
  11 Example: ./code2xmi Table.php Form.php etc
  12 Example: ./code2xmi `find HTML/ -name '*.php'`
  13
  14 The output will be a single file named umlOut.xmi and it will be generated in
  15 the same path were the script was run.
  16
  17 This script generates a light xmi file (Class only no diagrams will be
  18 generated). This xmi file will include all the classes, the functions and the
  19 attributes that are content in the php file.
  20 All the documentation that belongs to a class or a function or an attribute is
  21 attached to it in the corresponding xmi line, so when you open the xmi file you
  22 will have your object with all the information that matters.
  23
  24 This script works with php pear coding standars
  25 (http://pear.php.net/manual/en/standards.php), this is an important aspect.
  26
  27 This script will get from the documentation all the information have fulfilled
  28 those standars. All the remaining documentation will be put in the main
  29 (class, function or attribute) documentation.
  30
  31 Example: @return array() List of names --> In this case 'List of names' will be
  32 put in the main documentation as Returns: List of names
  33
  34 Example: @author Martin Marrese <m_marrese@argentina.com> --> will be put in
  35 the main documentations without any change.
  36
  37 This is a very simple script that have certain limitatios, for example a
  38 function line must be in ONE line, if not, the information of it will be wrong.
  39 Spaces between parameters are contemplated.
  40
  41 Example of a wrong line: function parseParenthesis( param1,
  42                                                     param2=null)
  43
  44 This line must be written this way:
  45 function parseParenthesis(param1, param2=null)
  46
  47 For a complete example you may check the Tabla.php archive.