source: branches/unified_backend/devutils/makedocs.pl.in @ 594

Last change on this file since 594 was 72, checked in by yermol, 15 years ago

work-in-progress commit to Unified Backend branch.

added devutils directory for server side convenience scripts

svn_commit.pl front-end to svn commit to update about.html on submit.
makedocs.pl to generates JSDoc and PHPDoc documentation.

added Configure.php script to generate cli script paths and to set perms.
added index.html
added README, INSTALL, README_DEVELOPERS
added examples/simple_example.html
added ddt.js debug trace message to text area class.
htmlarea.js reworked

  • reorganized to group related pieces together.
  • JSDoc headers added to all methods
  • debugging trace messages added to entry points of most methods.
File size: 1.6 KB
Line 
1#![@@PERL@@]
2
3# [NOSTRIP
4# -----------------------------------------------------------------
5# Copyright (C) DTLink, LLC.
6# http://www.dtlink.com and http://www.formvista.com
7# -----------------------------------------------------------------
8# This code is distributed under the the sames terms as Xinha
9# itself. (HTMLArea license based on the BSD license)
10#
11# Please read license.txt in this package for details.
12#
13# All software distributed under the Licenses is provided strictly on
14# an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
15# IMPLIED, AND DTLINK LLC HEREBY DISCLAIMS ALL SUCH
16# WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF
17# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT,
18# OR NON-INFRINGEMENT.
19# ------------------------------------------------------------------
20# NOSTRIP]
21
22# are we running from a webserver?
23
24if ( $ENV{ "HTTP_HOST" } != NULL )
25   {
26   print( "No\n" );
27   exit( -1 );
28   }
29
30# a little error checking never hurt anyone. Make sure it's a Xinha directory
31
32if ( ! -e ".xinha_root" )
33   {
34   print "makedocs.pl must be called from the Xinha root directory\n";
35   exit -1;
36   }
37
38# we assume phpdoc in our path.
39# phpdoc can't handle .js files.
40
41system( "phpdoc -o \"HTML:frames:earthli\" -ric ddt.js -d ./ -t ./docs/php_backend_reference -ti 'Xinha PHP Backend Programmers Reference'" );
42
43# we assume JSDoc in our path
44# see http://jsdoc.sourceforge.net
45#
46# /usr/local/src/JSDoc-1.9.3.1
47
48system( "jsdoc.pl -d ./docs/js_reference --private --package-naming --project-name=Xinha --recursive *" );
49
50# END
Note: See TracBrowser for help on using the repository browser.