Changes between Version 29 and Version 30 of statusdatabase


Ignore:
Timestamp:
Oct 16, 2014 11:07:16 AM (4 years ago)
Author:
tec
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • statusdatabase

    v29 v30  
     1== ARSF Status Page Documentation ==
     2Documentation for web files can be generated using PHPDoc and JSDoc as they contain comments which can be converted into HTML documentation.
     3
     4The gist of the status web stuff is that the edit/{index,order}.php and progress/index.php files send AJAX queries to the API I created and that returns data back to the page.
     5The API essentially consists of a regular expression which matches the URL that the AJAX calls, and then passes that to a class which returns the data back to the browser. Look at the code, its relatively simple.
     6There is a database class which does all the heavy lifting, basically it just runs queries on tables and views. Even then the actual database does the majority of work, due to my awesome, yet evil-looking SQL code.
     7 
     8PHPDoc command to generate documentation. JSDoc command is similar, there are a few ways to get JSDoc so I wont document the command here.
     9{{{
     10phpdoc run --title "ARSF Status Documentation" --visibility "public,protected,private" --sourcecode -p  -t OUTPUT_DIRECTORY -d WEBFILES_DIRECTORY
     11}}}
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
    126== Structure of new ARSF Database ==
    227