From 0757b4edb33d6a773e1313b5b477cd49851e15a0 Mon Sep 17 00:00:00 2001 From: Kevin Fourie Date: Wed, 21 Jan 2009 13:14:33 +0000 Subject: [PATCH] Added some PHPDoc related files and directories. --- docs/gendocs.sh | 12 ++++++++++++ docs/kt-phpdoc.ini | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/phpdoc/.empty | 0 tutorials/KTAPI/KTAPI.pkg | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 165 insertions(+), 0 deletions(-) create mode 100755 docs/gendocs.sh create mode 100644 docs/kt-phpdoc.ini create mode 100644 docs/phpdoc/.empty create mode 100644 tutorials/KTAPI/KTAPI.pkg diff --git a/docs/gendocs.sh b/docs/gendocs.sh new file mode 100755 index 0000000..5b87a78 --- /dev/null +++ b/docs/gendocs.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +rm -rf phpdoc/* + +DATETIME=`date` +VERSION=`cat VERSION-NAME.txt` + +cp kt-phpdoc.ini kt-phpdoc.ini.orig +sed -i -e "s/##VERSION##/$VERSION($DATETIME)/" kt-phpdoc.ini +phpdoc -c kt-phpdoc.ini +mv kt-phpdoc.ini.orig kt-phpdoc.ini + diff --git a/docs/kt-phpdoc.ini b/docs/kt-phpdoc.ini new file mode 100644 index 0000000..c1f57ec --- /dev/null +++ b/docs/kt-phpdoc.ini @@ -0,0 +1,102 @@ +;; phpDocumentor parse configuration file +;; +;; This file is designed to cut down on repetitive typing on the command-line or web interface +;; You can copy this file to create a number of configuration files that can be used with the +;; command-line switch -c, as in phpdoc -c default.ini or phpdoc -c myini.ini. The web +;; interface will automatically generate a list of .ini files that can be used. +;; +;; default.ini is used to generate the online manual at http://www.phpdoc.org/docs +;; +;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini +;; +;; Copyright 2002, Greg Beaver +;; +;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them + +[Parse Data] +;; title of all the documentation +;; legal values: any string +title = KnowledgeTree ##VESION## + +;; parse files that start with a . like .bash_profile +;; legal values: true, false +hidden = true + +;; show elements marked @access private in documentation by setting this to on +;; legal values: on, off +parseprivate = on + +;; parse with javadoc-like description (first sentence is always the short description) +;; legal values: on, off +javadocdesc = off + +;; add any custom @tags separated by commas here +;; legal values: any legal tagname separated by commas. +;customtags = mytag1,mytag2 + +;; This is only used by the XML:DocBook/peardoc2 converter +defaultcategoryname = Documentation + +;; what is the main package? +;; legal values: alphanumeric string plus - and _ +defaultpackagename = KnowledgeTree + +;; output any parsing information? set to on for cron jobs +;; legal values: on +;quiet = on + +;; parse a PEAR-style repository. Do not turn this on if your project does +;; not have a parent directory named "pear" +;; legal values: on/off +;pear = on + +;; where should the documentation be written? +;; legal values: a legal path +;target = /home/cellog/output +target = phpdoc + +;; Which files should be parsed out as special documentation files, such as README, +;; INSTALL and CHANGELOG? This overrides the default files found in +;; phpDocumentor.ini (this file is not a user .ini file, but the global file) +readmeinstallchangelog = README, INSTALL, FAQ, LICENSE, COPYING, CHANGELOG, LICENSE + +;; limit output to the specified packages, even if others are parsed +;; legal values: package names separated by commas +;packageoutput = package1,package2 + +;; comma-separated list of files to parse +;; legal values: paths separated by commas +;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory + +;; comma-separated list of directories to parse +;; legal values: directory paths separated by commas +;directory = /path1,/path2,.,..,subdirectory +;directory = /home/jeichorn/cvs/pear +;directory = /home/cellog/workspace/phpdoc +directory = ../ + +;; template base directory (the equivalent directory of /phpDocumentor) +;templatebase = /path/to/my/templates + +;; directory to find any example files in through @example and {@example} tags +;examplesdir = /path/to/my/templates + +;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore +;; legal values: any wildcard strings separated by commas +;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value +;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/ +ignore = thirdparty/ + +;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format +;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib, +;; HTML:frames:earthli, +;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de, +;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli +;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS +;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default +;output=HTML:frames:earthli,HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:frames:DOM/earthli,HTML:frames:DOM/phphtmllib,HTML:frames:phpedit,HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS +output=HTML:frames:DOM/earthli + +;; turn this option on if you want highlighted source code for every file +;; legal values: on/off +sourcecode = on diff --git a/docs/phpdoc/.empty b/docs/phpdoc/.empty new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/phpdoc/.empty diff --git a/tutorials/KTAPI/KTAPI.pkg b/tutorials/KTAPI/KTAPI.pkg new file mode 100644 index 0000000..630a121 --- /dev/null +++ b/tutorials/KTAPI/KTAPI.pkg @@ -0,0 +1,51 @@ + + + KTAPI User Guide + Documentation, examples and tutorials for the KnowledgeTree API (KTAPI) + + + + KnowledgeTree Team + + This documentation is maintained by the {@link mailto:info@knowledgetree.com KnowledgeTree Team}. + + + + {@toc} + + Introduction + + This is an introductory blurb about the KTAPI Package. + + + Examples + + This is a blurb about the KTAPI examples offered here. + + + Example 1 + + This is KTAPI example one. + Example 1 +32 +33 +34 public function KTAPI_Error($msg, $obj = null) +35 { +36 if (PEAR::isError($obj)) +37 { +38 parent::PEAR_Error($msg . ' - ' . $obj->getMessage()); +39 } +40 else +41 { +42 parent::PEAR_Error($msg); +43 } +44 } +45 +46 +47 + + + + + + -- libgit2 0.21.4