From 98dbe6f0d2edfff3a1f5785504504b4a6e5dd4eb Mon Sep 17 00:00:00 2001 From: "ctrlaltca@gmail.com" <> Date: Sat, 19 Nov 2011 11:33:31 +0000 Subject: updating phpDocumentor, part 2: add new version --- .../DocBook/peardoc2/templates/default/options.ini | 39 +++++++ .../templates/default/templates/category.tpl | 26 +++++ .../peardoc2/templates/default/templates/class.tpl | 29 ++++++ .../templates/default/templates/class_summary.tpl | 53 ++++++++++ .../templates/default/templates/constants.tpl | 68 ++++++++++++ .../templates/default/templates/docblock.tpl | 116 +++++++++++++++++++++ .../templates/default/templates/errors.tpl | 21 ++++ .../templates/default/templates/globals.tpl | 69 ++++++++++++ .../templates/default/templates/imethods.tpl | 24 +++++ .../peardoc2/templates/default/templates/ivars.tpl | 26 +++++ .../templates/default/templates/method.tpl | 45 ++++++++ .../templates/default/templates/package.tpl | 26 +++++ .../templates/default/templates/tutorial.tpl | 21 ++++ .../peardoc2/templates/default/templates/var.tpl | 15 +++ 14 files changed, 578 insertions(+) create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/options.ini create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/category.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class_summary.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/constants.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/docblock.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/errors.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/globals.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/imethods.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/ivars.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/method.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/package.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/tutorial.tpl create mode 100755 buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/var.tpl (limited to 'buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default') diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/options.ini b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/options.ini new file mode 100755 index 00000000..cdb08f38 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/options.ini @@ -0,0 +1,39 @@ +;; XML DocBook peardoc2 options +usepear = true + +;; preserve package page docbook tags that don't have an entry in the ppage section +;; we preserve every tag, as this is how it works +;; this is after all a docbook converter! +preservedocbooktags = true + +;; separate file for class and page docblocks and minor details (variables, globals, defines) +separatepage = true + +[typechanging] +true = &true; +false = &false; +null = &null; + +[desctranslate] +ul = "\n" +/ul = "\n" +ol = "\n" +/ol = "\n" +li = "\n" +/li = "\n" +code = +/code = "\n" +pre = +p = +/p = "\n" +b = +/b = +i = +/i = +var = +/var = +kbd = +/kbd = +samp = +/samp = "\n" diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/category.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/category.tpl new file mode 100755 index 00000000..7c95b11e --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/category.tpl @@ -0,0 +1,26 @@ + +{$category} +{section name=ids loop=$ids} +&{$ids[ids]}; +{/section} + + + \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class.tpl new file mode 100755 index 00000000..72b9fea2 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class.tpl @@ -0,0 +1,29 @@ + + + {$class_name} + {$classname} + +{section name=methods loop=$method_ids} +&{$method_ids[methods]}; +{/section} + + + \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class_summary.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class_summary.tpl new file mode 100755 index 00000000..03b42703 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/class_summary.tpl @@ -0,0 +1,53 @@ + + + Class Summary {$class_name} + {$sdesc} + + + {$sdesc} + {$desc|default:"¬documented;"} + + +Class Trees for {$class_name} + + {section name=tree loop=$class_tree} + {section name=mine loop=$class_tree[tree]} {/section} + {section name=mine loop=$class_tree[tree]} {/section} + {section name=mine loop=$class_tree[tree]} {/section} {$class_tree[tree]} + {/section} + {section name=tree loop=$class_tree} + {section name=mine loop=$class_tree[tree]} {/section} + + {/section} + +{if $children} + + + Classes that extend {$class_name} + + + + Class + Summary + + + +{section name=kids loop=$children} + + {$children[kids].link} + {$children[kids].sdesc} + +{/section} + + +
+ +{/if} +{if $imethods} + + {$class_name} Inherited Methods + +{include file="imethods.tpl" ivars=$ivars} +{/if} + + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/constants.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/constants.tpl new file mode 100755 index 00000000..24588e88 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/constants.tpl @@ -0,0 +1,68 @@ + + + Package {$package} Constants + Constants defined in and used by {$package} + + + All Constants +{section name=files loop=$defines} + + + Constants defined in {$defines[files].name} + + + + Constants defined in {$defines[files].name} +{section name=d loop=$defines[files].defines} +{if $defines[files].defines[d].conflicts}{assign var="defineconflict" value=true}{/if} +{/section} + + + + Name + Value + Line Number +{if $defineconflict} + Conflicts with other packages +{/if} + + + +{section name=d loop=$defines[files].defines} + + {$defines[files].defines[d].name} + {$defines[files].defines[d].value} + {$defines[files].defines[d].line_number} +{if $defineconflict} + {$defines[files].defines[d].conflicts} +{/if} + +{/section} + + +
+ + +{/section} + + + + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/docblock.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/docblock.tpl new file mode 100755 index 00000000..ab140b3b --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/docblock.tpl @@ -0,0 +1,116 @@ +{if $var} +{assign var="num" value="refsect3"} +{else} +{assign var="num" value="refsect1"} +{/if} + <{$num} id="{$id}.desc"> + &title.desc; +{if $line_number} + + Source on line #: {if $class_slink}{$class_slink}{else}{$line_number}{/if} + +{/if} +{if $var} + + {$sdesc|default:"¬documented;"} + +{/if} +{if $desc} + {$desc} +{else} +{if $var && $sdesc} +{else} + ¬documented; +{/if} +{/if} + +{if $params} + <{$num} id="{$id}.param"> + &title.param; + +{section name=params loop=$params} + + + + {assign var="temp" value=$params[params].name} + {if strpos($params[params].type, '|') || + strpos($cparams.$temp.cdatatype, '>')} + {$params[params].type} + {else} + {if $params[params].type == 'integer'} + {assign var="paramtype" value="int"} + {elseif $params[params].type == 'boolean'} + {assign var="paramtype" value="bool"} + {else} + {assign var="paramtype" value=$params[params].type} + {/if} + {if in_array($paramtype, array('bool', 'int', 'float', 'string', 'mixed', 'object', 'resource', 'array', 'res'))} + &type.{$paramtype}; + {else} + {$paramtype} + {/if} + {/if} + {$params[params].name|replace:"&":"&"} + + + + {$params[params].description} + + + + +{/section} + + +{/if} +{foreach from=$tags item="tag" key="tagname"} +{if $tagname != 'static' && $tagname != 'author' && $tagname != 'version' && $tagname != 'copyright' && $tagname != 'package' && $tagname != 'subpackage' && $tagname != 'example'} + <{$num} id="{$id}.{$tagname}"> + &title.{$tagname}; + {section name=t loop=$tag} + + {$tag[t].keyword} {$tag[t].data} + + {/section} + +{elseif $tagname == 'deprecated'} + <{$num} id="{$id}.{$tagname}"> + &title.note; + ¬e.deprecated; + {section name=t loop=$tag} + + {$tag[t].data} + + {/section} + +{elseif $tagname == 'static'} +{assign var="canstatic" value=true} +{elseif $tagname == 'example'} + <{$num} id="{$id}.{$tagname}"> + Examples + {section name=t loop=$tag} + {$tag[t].data} + {/section} + +{elseif $tagname != 'package' && $tagname != 'subpackage'} + <{$num} id="{$id}.{$tagname}"> + {$tagname}{* <-- need language snippets support for phpDocumentor, will use this instead *} + {section name=t loop=$tag} + + {$tagname} {$tag[t].data} + + {/section} + +{/if} +{/foreach} +{if $canstatic} + <{$num} id="{$id}.note"> + &title.note; + ¬e.canstatic; + +{else} + <{$num} id="{$id}.note"> + &title.note; + ¬e.notstatic; + +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/errors.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/errors.tpl new file mode 100644 index 00000000..0f526584 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/errors.tpl @@ -0,0 +1,21 @@ +{include file="header.tpl" noleftindex=true} +{section name=files loop=$files} +{$files[files].file}
+{/section} +{foreach key=file item=issues from=$all} + +

{$file}

+{if count($issues.warnings)} +

Warnings:


+{section name=warnings loop=$issues.warnings} +{$issues.warnings[warnings].name} - {$issues.warnings[warnings].listing}
+{/section} +{/if} +{if count($issues.errors)} +

Errors:


+{section name=errors loop=$issues.errors} +{$issues.errors[errors].name} - {$issues.errors[errors].listing}
+{/section} +{/if} +{/foreach} +{include file="footer.tpl"} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/globals.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/globals.tpl new file mode 100755 index 00000000..7392d87a --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/globals.tpl @@ -0,0 +1,69 @@ + + + Package {$package} Global Variables + Global Variables defined in and used by {$package} + + + All Global Variables +{section name=files loop=$globals} + + + Global Variables defined in {$globals[files].name} + + + + Global Variables defined in {$globals[files].name} +{section name=d loop=$globals[files].globals} +{if $globals[files].globals[d].conflicts}{assign var="globalconflict" value=true}{/if} +{/section} + + + + Name + Value + Line Number +{if $globalconflict} + Conflicts with other packages +{/if} + + + +{section name=d loop=$globals} + + +{$globals[files].globals[d].name} + {$globals[files].globals[d].value} + {$globals[files].globals[d].line_number} +{if $globalconflict} + {$globals[files].globals[d].conflicts} +{/if} + +{/section} + + +
+ + +{/section} + + + + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/imethods.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/imethods.tpl new file mode 100755 index 00000000..c0be1bf7 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/imethods.tpl @@ -0,0 +1,24 @@ + +{section name=classes loop=$imethods} + + Inherited from {$imethods[classes].parent_class} + + + + Method Name + Summary + + + +{section name=m loop=$imethods[classes].imethods} + + {if $imethods[classes].imethods[m].constructor} Constructor{/if} {$imethods[classes].imethods[m].link} + {$imethods[classes].imethods[m].sdesc|default:"¬documented;"} + +{/section} + + +
+{/section} + + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/ivars.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/ivars.tpl new file mode 100755 index 00000000..3b9eecf9 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/ivars.tpl @@ -0,0 +1,26 @@ + +{section name=classes loop=$ivars} + + Inherited from {$ivars[classes].parent_class} + + + + Variable Name + Summary + Default Value + + + +{section name=m loop=$ivars[classes].ivars} + + {if $ivars[classes].ivars[m].constructor} Constructor{/if} {$ivars[classes].ivars[m].link} + {$ivars[classes].ivars[m].sdesc|default:"¬documented;"} + {$ivars[classes].ivars[m].default|default:"&null;"} + +{/section} + + +
+{/section} + + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/method.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/method.tpl new file mode 100755 index 00000000..fc53f5dc --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/method.tpl @@ -0,0 +1,45 @@ + + + {if $function_call.constructor}constructor {/if}{$class}::{$function_name} + {$sdesc|default:$function_name} + + + + + require_once '{$source_location}'; + + + {$function_return}{if $function_call.returnsref}&{/if} + {if $function_call.constructor}constructor {/if}{$class}::{$function_name} +{if count($function_call.params)} +{section name=params loop=$function_call.params} + {if @strpos('>',$function_call.params[params].type)}{/if}{$function_call.params[params].type}{if @strpos('>',$function_call.params[params].type)}{/if} {if $function_call.params[params].hasdefault} {/if}{$function_call.params[params].name|replace:"&":"&"}{if $function_call.params[params].hasdefault} = {$function_call.params[params].default}{/if} +{/section} +{else} + +{/if} + + + +{include file="docblock.tpl" cparams=$params params=$function_call.params desc=$desc tags=$tags} + + + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/package.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/package.tpl new file mode 100755 index 00000000..5b6bfc1c --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/package.tpl @@ -0,0 +1,26 @@ + +{$package} +{section name=ids loop=$ids} +{$ids[ids]} +{/section} + + + \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/tutorial.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/tutorial.tpl new file mode 100755 index 00000000..e2cb70c4 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/tutorial.tpl @@ -0,0 +1,21 @@ +{$contents} + + \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/var.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/var.tpl new file mode 100755 index 00000000..0d490e46 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/XML/DocBook/peardoc2/templates/default/templates/var.tpl @@ -0,0 +1,15 @@ + + Class Variables +{section name=var loop=$vars} + + {$vars[var].var_type} {$vars[var].var_name}{if $vars[var].default} = {$vars[var].var_default}{/if} + +{section name=v loop=$vars[var].var_overrides} + + Overrides {$vars[var].var_overrides[v].link}{if $vars[var].var_overrides[v].sdesc}: {$vars[var].var_overrides[v].sdesc|default:""}{/if} + +{/section} +{include file="docblock.tpl" var=true desc=$vars[var].desc sdesc=$vars[var].sdesc tags=$vars[var].tags line_number=$line_number id=$vars[var].id} + +{/section} + -- cgit v1.2.3