lib/MECON/Graph/external/jpgraph/src/utils/jpdocgen/README

   1 $Id: README,v 1.4 2002/08/06 08:42:19 aditus Exp $
   2
   3 DDDA Public Release
   4 ===================
   5
   6 This directory contains all the files necessary to
   7 run the DDDA (Database Driven Documentation Architecture).
   8
   9 1. Introduction
  10 ---------------
  11 The DDDA system lets you parse a project which may consist
  12 of multiple PHP source file and record all classes, methods
  13 and global functions in a database.
  14
  15 When this is done you can add comments and examples which
  16 is also stored in the database. All this is done through a
  17 GUI provided in this application.
  18
  19 Whenever the source is changed you just update the DB
  20 and the new methods and classes will be added while keeping
  21 any old comments and description.
  22
  23 It will automatically calculate a percentage figure for
  24 each class and method that indicates how well it is documented.
  25
  26 When you are happy with the result you can automatically
  27 generate reference documentation from this DB.
  28
  29 2. Installation
  30 ---------------
  31 1. Copy all the files to a directory of your choice.
  32 2. Edit 'de_utils.php' to match your MySQL DB server
  33 settings (user and pwd)
  34 3. Point your browser to jpdocedit.php. The first time
  35 this script is run it will setup a few DB tables.
  36
  37 3. Usage
  38 --------
  39 Most of the use should be self explaining.
  40
  41 The basic usage cycle (after the initial setup) is:
  42
  43 1. Parse files after code changes
  44 2. Add documentation to classes and methods
  45 3. Generate documentation
  46
  47 Go back to 1.
  48
  49 In the opening project window you have options to
  50 setup and edit one or several projects.
  51
  52 The first thing you must do is to create a project
  53 and define a number of files belonging to this project.
  54 After that you need to update the DB by first going
  55 into the project view and then pressing the 'Update DB'
  56 button. Note that the update function is smart enough
  57 not to parse files which are up to date.
  58 (By clicking the 'Force' checkbox you can force all files
  59 in the project to be parsed)
  60
  61 Then click on the methods or class names where you
  62 want to add documentation. To help keep track of your
  63 documentation effort there is a weighted tracking system
  64 built in which will give you, as a percentage, the
  65 documentation coverage. This will help direct your efforts
  66 to the classes most in need of more documentation.
  67
  68 When you like to generate the documentation you just need
  69 to press the "Generate docs" button and the HTML files
  70 will be written to the output directory you have specified.
  71
  72 Some notes:
  73 The button "Check DB" performs a consistency check on
  74 the DB.
  75 The button "Show documentation" opens the generated
  76 documentations.
  77 The button "Update DB" runs the parser of any files that
  78 has been modified since the last time parsing was done.
  79
  80
  81 4. Browser compatibility
  82 ------------------------
  83 I have only tested this with Opera 6.x and at the moment
  84 it will not work with MS IE due to (what I consider) bugs
  85 in IE.
  86
  87 When I get some time I will add some workarounds for the
  88 bugs in IE.
  89
  90 Appendix
  91 A. Release history
  92 ----------------------------------------------------------
  93 Date            Version     Comment
  94 ----------------------------------------------------------
  95 15 July 2002     1.3        Added global project directory
  96 4  July 2002     1.2        First public release
  97
  98 [EOF]
  99
 100