Peter M. Groen / knowledgetree

Commit 0757b4edb33d6a773e1313b5b477cd49851e15a0

Authored by Kevin Fourie 2009-01-21 13:14:33 +0000

Added some PHPDoc related files and directories.

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@9737 c91229c3-7414-0410-bfa2-8a42b809f60b

Inline Side-by-side

Showing 4 changed files with 165 additions and 0 deletions

docs/gendocs.sh 0 → 100755

View file @0757b4e

	1	+#!/bin/bash
	2	+
	3	+rm -rf phpdoc/*
	4	+
	5	+DATETIME=`date`
	6	+VERSION=`cat VERSION-NAME.txt`
	7	+
	8	+cp kt-phpdoc.ini kt-phpdoc.ini.orig
	9	+sed -i -e "s/##VERSION##/$VERSION($DATETIME)/" kt-phpdoc.ini
	10	+phpdoc -c kt-phpdoc.ini
	11	+mv kt-phpdoc.ini.orig kt-phpdoc.ini
	12	+
...	...

docs/kt-phpdoc.ini 0 → 100644

View file @0757b4e

	1	+;; phpDocumentor parse configuration file
	2	+;;
	3	+;; This file is designed to cut down on repetitive typing on the command-line or web interface
	4	+;; You can copy this file to create a number of configuration files that can be used with the
	5	+;; command-line switch -c, as in phpdoc -c default.ini or phpdoc -c myini.ini. The web
	6	+;; interface will automatically generate a list of .ini files that can be used.
	7	+;;
	8	+;; default.ini is used to generate the online manual at http://www.phpdoc.org/docs
	9	+;;
	10	+;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini
	11	+;;
	12	+;; Copyright 2002, Greg Beaver <cellog@php.net>
	13	+;;
	14	+;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them
	15	+
	16	+[Parse Data]
	17	+;; title of all the documentation
	18	+;; legal values: any string
	19	+title = KnowledgeTree ##VESION##
	20	+
	21	+;; parse files that start with a . like .bash_profile
	22	+;; legal values: true, false
	23	+hidden = true
	24	+
	25	+;; show elements marked @access private in documentation by setting this to on
	26	+;; legal values: on, off
	27	+parseprivate = on
	28	+
	29	+;; parse with javadoc-like description (first sentence is always the short description)
	30	+;; legal values: on, off
	31	+javadocdesc = off
	32	+
	33	+;; add any custom @tags separated by commas here
	34	+;; legal values: any legal tagname separated by commas.
	35	+;customtags = mytag1,mytag2
	36	+
	37	+;; This is only used by the XML:DocBook/peardoc2 converter
	38	+defaultcategoryname = Documentation
	39	+
	40	+;; what is the main package?
	41	+;; legal values: alphanumeric string plus - and _
	42	+defaultpackagename = KnowledgeTree
	43	+
	44	+;; output any parsing information? set to on for cron jobs
	45	+;; legal values: on
	46	+;quiet = on
	47	+
	48	+;; parse a PEAR-style repository. Do not turn this on if your project does
	49	+;; not have a parent directory named "pear"
	50	+;; legal values: on/off
	51	+;pear = on
	52	+
	53	+;; where should the documentation be written?
	54	+;; legal values: a legal path
	55	+;target = /home/cellog/output
	56	+target = phpdoc
	57	+
	58	+;; Which files should be parsed out as special documentation files, such as README,
	59	+;; INSTALL and CHANGELOG? This overrides the default files found in
	60	+;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
	61	+readmeinstallchangelog = README, INSTALL, FAQ, LICENSE, COPYING, CHANGELOG, LICENSE
	62	+
	63	+;; limit output to the specified packages, even if others are parsed
	64	+;; legal values: package names separated by commas
	65	+;packageoutput = package1,package2
	66	+
	67	+;; comma-separated list of files to parse
	68	+;; legal values: paths separated by commas
	69	+;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
	70	+
	71	+;; comma-separated list of directories to parse
	72	+;; legal values: directory paths separated by commas
	73	+;directory = /path1,/path2,.,..,subdirectory
	74	+;directory = /home/jeichorn/cvs/pear
	75	+;directory = /home/cellog/workspace/phpdoc
	76	+directory = ../
	77	+
	78	+;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
	79	+;templatebase = /path/to/my/templates
	80	+
	81	+;; directory to find any example files in through @example and {@example} tags
	82	+;examplesdir = /path/to/my/templates
	83	+
	84	+;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
	85	+;; legal values: any wildcard strings separated by commas
	86	+;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
	87	+;ignore = path/to/ignore,list.php,myfile.php,subdirectory/
	88	+ignore = thirdparty/
	89	+
	90	+;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
	91	+;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
	92	+;; HTML:frames:earthli,
	93	+;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
	94	+;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
	95	+;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
	96	+;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
	97	+;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
	98	+output=HTML:frames:DOM/earthli
	99	+
	100	+;; turn this option on if you want highlighted source code for every file
	101	+;; legal values: on/off
	102	+sourcecode = on
...	...

docs/phpdoc/.empty 0 → 100644

View file @0757b4e

tutorials/KTAPI/KTAPI.pkg 0 → 100644

View file @0757b4e

	1	+<refentry id="{@id}">
	2	+ <refnamediv>
	3	+ <refname>KTAPI User Guide</refname>
	4	+ <refpurpose>Documentation, examples and tutorials for the KnowledgeTree API (KTAPI)</refpurpose>
	5	+ </refnamediv>
	6	+ <refsynopsisdiv>
	7	+ <author>
	8	+ KnowledgeTree Team
	9	+ <authorblurb>
	10	+ This documentation is maintained by the {@link mailto:info@knowledgetree.com KnowledgeTree Team}.
	11	+ </authorblurb>
	12	+ </author>
	13	+ </refsynopsisdiv>
	14	+ {@toc}
	15	+ <refsect1 id="{@id intro}">
	16	+ <title>Introduction</title>
	17	+ <para>
	18	+ This is an introductory blurb about the KTAPI Package.
	19	+ </para>
	20	+ <refsect2 id="{@id examples}">
	21	+ <title>Examples</title>
	22	+ <para>
	23	+ This is a blurb about the KTAPI examples offered here.
	24	+ </para>
	25	+ <refsect3 id="{@id example1}">
	26	+ <title>Example 1</title>
	27	+ <para>
	28	+ This is KTAPI example one.
	29	+ <example><title>Example 1</title>
	30	+32 <programlisting role="tutorial">
	31	+33
	32	+34 public function KTAPI_Error($msg, $obj = null)
	33	+35 {
	34	+36 if (PEAR::isError($obj))
	35	+37 {
	36	+38 parent::PEAR_Error($msg . ' - ' . $obj->getMessage());
	37	+39 }
	38	+40 else
	39	+41 {
	40	+42 parent::PEAR_Error($msg);
	41	+43 }
	42	+44 }
	43	+45
	44	+46 </programlisting>
	45	+47 </example>
	46	+ </para>
	47	+ </refsect3>
	48	+ </refsect2>
	49	+ </refsect1>
	50	+</refentry>
	51	+
...	...