2 define('AT_INCLUDE_PATH', '../../../include/');
3 require (AT_INCLUDE_PATH.'vitals.inc.php');
4 //$_custom_css = $_base_path . 'mods/hello_world/module.css'; // use a custom stylesheet
5 require (AT_INCLUDE_PATH.'header.inc.php');
8 <h1>Welcome to PHPDoc!</h1>
10 <p> By default PHPDoc scans the ATutor include directory, where 99% of the API exists. If you wish to change that, edit the path in the source code of this file, redefining the value of "setSourceDirectory", then reload this page.
17 // WARNING: long runtimes! Make modifications
18 // to the php[3].ini if neccessary. A P3-500
19 // needs slightly more than 30 seconds to
20 // document phpdoc itself.
22 // Directory with include files
23 define("PHPDOC_INCLUDE_DIR", AT_INCLUDE_PATH."../mods/phpdoc/PHPDoc/");
24 // Important: set this to the Linebreak sign of your system!
25 define("PHPDOC_LINEBREAK", "\r\n");
27 // main PHPDoc Include File
28 include(AT_INCLUDE_PATH."../mods/phpdoc/PHPDoc/prepend.php");
32 // Sets the name of your application.
33 // The name of the application gets used in many default templates.
34 $doc->setApplication("ATutor LMS API");
36 // directory where your source files reside:
37 $doc->setSourceDirectory(AT_INCLUDE_PATH);
39 // save the generated docs here:
40 $doc->setTarget(AT_INCLUDE_PATH."../mods/phpdoc/PHPDoc/apidoc/keep/");
42 // use these templates:
43 $doc->setTemplateDirectory(AT_INCLUDE_PATH."../mods/phpdoc/PHPDoc/renderer/html/templates/");
45 // source files have one of these suffixes:
46 $doc->setSourceFileSuffix( array ("php", "inc") );
48 // parse and generate the xml files
51 // turn xml in to html using templates
54 printf("%d seconds needed\n\n.", time() - $start);
59 <p>The generated XML and HTML files can be found in
60 the directory specified with setTarget() in the source code of this file. By default this location is "installationdir/apidoc/".
61 Within this directory is another directory named "keep/". It contains a stylesheet file and
62 a frameset you can use to browse the HTML files. </p>
64 <p><a href="mods/phpdoc/PHPDoc/apidoc/keep/index2.html" target="atutorapi">View API Documentation</a> (opens a new window)</p>
66 <p>For assistance with PHPDoc, please contact the developer, at:
68 <a href="mailto:ulf.wendel@phpdoc.de">ulf.wendel@phpdoc.de</a>
70 <?php require (AT_INCLUDE_PATH.'footer.inc.php'); ?>