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 script generates a light xmi file. This xmi file will include all the
   8 classes, the functions and the attributes that are content in the php file.
   9 All the documentation that belongs to a class or a function or an attribute is
  10 attached to it in the corresponding xmi line, so when you open the xmi file you
  11 will have your object with all the information that matters.
  12
  13 This script works with php pear coding standars
  14 (http://pear.php.net/manual/en/standards.php), this is an important aspect.
  15
  16 This script will get from the documentation all the information have fulfilled
  17 those standars. All the remaining documentation will be put in the main
  18 (class, function or attribute) documentation.
  19
  20 Example: @return array() List of names --> In this case 'List of names' will be
  21 put in the main documentation as Returns: List of names
  22
  23 Example: @author Martin Marrese <m_marrese@argentina.com> --> will be put in
  24 the main documentations without any change.
  25
  26 This is a very simple script that have certain limitatios, for example a
  27 function line must be in ONE line, if not, the information of it will be wrong.
  28 Spaces between parameters are contemplated.
  29
  30 Example of a wrong line: function parseParenthesis( param1,
  31                                                     param2=null)
  32
  33 This line must be written this way:
  34 function parseParenthesis(param1, param2=null)
  35