From dca8960e21273ed8100fa1fdaeab99ccf141a1f3 Mon Sep 17 00:00:00 2001
From: mikl <>
Date: Tue, 6 May 2008 07:53:08 +0000
Subject: Imported JS documentor jGrouseDoc-2.0
---
buildscripts/jGrouseDoc/skins/common/vm/common.vm | 604 ++++++++++++++++++++++
1 file changed, 604 insertions(+)
create mode 100644 buildscripts/jGrouseDoc/skins/common/vm/common.vm
(limited to 'buildscripts/jGrouseDoc/skins/common/vm')
diff --git a/buildscripts/jGrouseDoc/skins/common/vm/common.vm b/buildscripts/jGrouseDoc/skins/common/vm/common.vm
new file mode 100644
index 00000000..b46b62c6
--- /dev/null
+++ b/buildscripts/jGrouseDoc/skins/common/vm/common.vm
@@ -0,0 +1,604 @@
+#macro(writeLink $link)
+#set ($linkElement = $jg.get($link))
+$rootPath#if($linkElement.isContainer())
+#if($linkElement.isLogicalContainer())logical#{else}physical#end/${linkElement.path}.html#{else}
+logical/${linkElement.owner.path}.html#___$linkElement.localName#end
+#end
+
+
+#macro(writeContent $content)
+#foreach ($section in $content.sections)
+#if ($section.link && $section.resolvedPath && $section.resolvedPath.length() > 0)
+$section.text#else$section.text#end
+#end
+#end
+
+#macro (writeType $type)
+#writeContent($type)
+#end
+
+
+
+
+#macro(genCommonAttrs $comment)
+ #if($comment.author.size() > 0)
+
+
Authors:
+ #foreach($author in $comment.author)
+
#writeContent($author.content)
+ #end
+
+ #end
+ #if ($comment.see.size() > 0)
+
+
See also:
+ #foreach($see in $comment.see)
+
#writeContent($see.content)
+ #end
+
+ #end
+ #if ($comment.version.size() > 0)
+
+
Version:
+ #foreach($version in $comment.version)
+
#writeContent($version.content)
+ #end
+
+ #end
+ #if ($comment.timestamp.size() > 0)
+
+
Generated on:
+
$jg.project.timestamp
+
+ #end
+ #if ($comment.since.size() > 0)
+
+
Since:
+ #foreach($since in $comment.since)
+
#writeContent($since.content)
+ #end
+
+ #end
+ #if ($comment.deprecated.size() > 0)
+
+
Deprecated:
+ #foreach($dep in $comment.deprecated)
+
#writeContent($dep.content)
+ #end
+
+ #end
+#end
+
+
+#macro (writeFunctionParams $paramSet)
+#foreach($param in $paramSet.params)#if($velocityCount > 1), #end#if($param.hasModifier('optional'))[#end#writeType($param.typeLink) $param.name#if($param.hasModifier('optional'))]#end#end
+#end
+
+
+#macro(writeSrcURL $obj)
+ #if($obj.comment.srcUrl)
+ view source
+ #end
+#end
+
+
+#macro(writeParamOption $paramOption)
+
+
+ #if($paramOption.hasModifier("optional"))[#end
+ $paramOption.strModifiers
+ #writeType($paramOption.typeLink)
+ $paramOption.name
+ #if($paramOption.hasModifier("optional"))]#end
+
+ #writeContent($paramOption.content)
+
+#end
+
+
+#macro(writeParam $param)
+
+
+ #if($param.hasModifier("optional"))[#end${param.name}#if($param.hasModifier("optional"))]#end
+
+ #writeContent($param.content)
+ #if($param.children.size() > 0)
+
+ #foreach($paramOption in $param.children)
+ #writeParamOption($paramOption)
+ #end
+
+ #end
+
+#end
+
+
+#macro(writePhysOwner $element)
+ #if($element.hasSamePhysOwner)
+ Defined in
+ $element.physOwner.comment.name
+ #end
+#end
+
+
+
+
+#macro(writeFunctionDetails $func $memberType)
+ #set ($funcModifiers = $func.comment.modifiers)
+ #if ($func.comment.inheritdesc.size() == 0)
+ #set ($funcItself = $func)
+ #else
+ #set ($funcItself = $jg.get($func.comment.inheritdesc.get(0).name))
+ #end
+ #writeSrcURL($func)
+
+ #if ($funcItself.comment.paramSets.size() > 0)
+ #foreach($paramSet in $funcItself.comment.paramSets)
+
+
+ $funcModifiers
+ #writeType($funcItself.comment.typeLink)
+ ${funcItself.localName}(#writeFunctionParams($paramSet))
+
+
+ #end
+ #else
+
+
+ $funcModifiers
+ #writeType($funcItself.comment.typeLink)
+ ${funcItself.localName}()
+
+
+ #end
+
+ #if ($funcItself.comment.paramSets.size() > 0)
+
+
Parameters:
+ #foreach($paramSet in $funcItself.comment.paramSets)
+
+
#writeContent($paramSet.content)
+
+ #foreach($param in $paramSet.params)
+ #writeParam($param)
+ #end
+
+
+ #end
+
+ #end
+ #if($funcItself.comment.returnsTag )
+
+
Returns:
+
+ #set ($return = $funcItself.comment.returnsTag)
+ #writeContent($return.content)
+ #if($return.children.size() > 0)
+
+ #foreach($paramOption in $return.children)
+ #writeParamOption($paramOption)
+ #end
+
+ #end
+
+
+ #end
+ #if($funcItself.comment.throws.size() > 0)
+
+
Throws:
+ #foreach($throws in $funcItself.comment.throws)
+
#writeContent($throws.content)
+ #end
+
+ #end
+ #genCommonAttrs($funcItself.comment)
+ #writePhysOwner($func)
+
+#end
+
+
+#macro(writeVarDetails $var)
+ #set ($varModifiers = $var.comment.modifiers)
+ #if ($var.comment.inheritdesc.size() == 0)
+ #set ($varItself = $var)
+ #else
+ #set ($varItself = $jg.get($var.comment.inheritdesc.get(0).name))
+ #end
+
+ #writeSrcURL($var)
+
+
+ #genCommonAttrs($varItself.comment)
+ #writePhysOwner($var)
+
+#end
+
+
+
+
+#macro(writeLegacies $obj $memberType $memberName )
+ #foreach($legacy in $obj.legacies)
+ #if ($legacy.get($memberType).size() > 0)
+
+
+
+ #foreach($item in $legacy.get($memberType))#if($velocityCount > 1), #end
$item.localName#end
+
+
+
+ #end
+ #end
+#end
+
+
+
+#macro(writeVarSummary $variable)
+ #set ($varModifiers = $variable.comment.modifiers)
+ #if ($variable.comment.inheritdesc.size() == 0)
+ #set ($varItself = $variable)
+ #else
+ #set ($varItself = $jg.get($variable.comment.inheritdesc.get(0).name))
+ #end
+
+
+ #writeContent($varItself.comment.summary)
+
+#end
+
+
+#macro(writeFuncSummary $func)
+ #set ($funcModifiers = $func.comment.modifiers)
+ #if ($func.comment.inheritdesc.size() == 0)
+ #set ($funcItself = $func)
+ #else
+ #set ($funcItself = $jg.get($func.comment.inheritdesc.get(0).name))
+ #end
+ #if ($funcItself.comment.paramSets.size() != 0)
+ #foreach($paramSet in $funcItself.comment.paramSets)
+
+
$funcModifiers
+ #writeType($func.comment.typeLink)
+
$func.localName
+ (#writeFunctionParams($paramSet))
+
+ #end
+ #else
+
+
$funcModifiers
+ #writeType($func.comment.typeLink)
+
$func.localName()
+
+ #end
+
+ #writeContent($funcItself.comment.summary)
+
+#end
+
+
+#macro(writeLogicalSummary $class)
+
+
+ #writeContent($class.comment.summary)
+
+#end
+
+
+#macro(writeSummary $coll $elemType $elemName)
+ #if($coll.size() != 0)
+
+
+ #foreach($item in $coll)
+
+ #if ($elemType == "namespace" || $elemType == "class" || $elemType == "interface" || $elemType == "struct"|| $elemType == "object")
+ #writeLogicalSummary($item)
+ #elseif ($elemType == "function" || $elemType == "constructor" || $elemType == "ifunction" || $elemType == "event")
+ #writeFuncSummary($item)
+ #elseif ($elemType == "variable" || $elemType == "property")
+ #writeVarSummary($item)
+ #end
+
+ #end
+
+
+ #end
+#end
+
+
+
+#macro(writeDetails $object $elemType $memberName)
+ #if ($object.get($elemType).size() > 0)
+
+
+ #foreach($item in $object.get($elemType))
+ #if ($elemType == "function" || $elemType == "constructor" || $elemType == "ifunction" || $elemType == "event")
+ #writeFunctionDetails($item $elemType)
+ #elseif ($elemType == "variable" || $elemType == "property")
+ #writeVarDetails($item)
+ #end
+ #end
+
+ #end
+#end
+
+
+
+
+
+#macro(navigationPane $elementType)
+
+
+
+ -
+
+
+
+ -
+ #foreach($file in $jg.files)
+ #if(!$file.isModuleFile())
+
+ #end
+ #end
+
+
+
+
+
+
+ -
+
+
+
+ -
+ #foreach($module in $jg.modules)
+
+ #end
+
+
+
+
+
+
+
+#end
+
+#macro(writeCSS $rootPath $aux_path)
+
+
+ #if($aux_path && $aux_path != 'not_specified')
+
+ #end
+#end
+
+#macro(navbarPhys $isStartup)
+
+#end
+
+#macro(navbarLog $isStartup)
+
+#end
+
+#macro(writeClassAttributes $obj)
+#if($obj.comment.extends.size() > 0)
+
+ Extends
+ #foreach ($tagContent in $obj.comment.extends)
+ #if($velocityCount > 1), #end #writeContent($tagContent.content)
+ #end
+
+#end
+#if($obj.comment.implements.size() > 0)
+
+ Implements
+ #foreach ($tagContent in $obj.comment.implements)
+ #if($velocityCount > 1), #end #writeContent($tagContent.content)
+ #end
+
+#end
+
+#if($obj.subClasses.size() > 0)
+
+
+ #if($obj.commentType == "class")Direct Known Subclasses:#{else}All Known Subinterfaces:#end
+
+
+ #foreach($subclass in $obj.subClasses)#if($velocityCount > 1), #end
$subclass.fullName#end
+
+
+#end
+
+#if($obj.implementors.size() > 0)
+
+
+ All Known Implementing Classes:
+
+
+ #foreach($subclass in $obj.implementors)#if($velocityCount > 1), #end
$subclass.fullName#end
+
+
+#end
+#end
+
+#macro(writeModuleAttributes $obj)
+#if ($obj.comment.requires.size() > 0)
+
+ Requires modules:
+ #foreach($tagContent in $obj.comment.requires)
+ #if($velocityCount > 1), #end #writeContent($tagContent.content)
+ #end
+
+#end
+#end
+
+
+#macro(writeLogicalContainerSummary $obj)
+ #if ($obj.elementType == "logical_container" && $obj.commentType != "namespace")
+ #set($nested = "Nested")
+ #else
+ #set ($nested = "")
+ #end
+
+ #writeSummary($obj.get("class") "class" "$nested Class")
+ #writeSummary($obj.get("interface") "interface" "$nested Interface")
+ #writeSummary($obj.object "object" "$nested Object")
+ #writeSummary($obj.structure "structure" "$nested Structure")
+
+ #writeSummary($obj.variable "variable" "Variable")
+ #writeLegacies($obj "variable" "Variables")
+
+
+ #writeSummary($obj.property "property" "Property")
+ #writeLegacies($obj "property" "Properties" )
+
+ #writeSummary($obj.constructor "constructor" "Constructor")
+
+ #writeSummary($obj.function "function" "Function")
+ #writeLegacies($obj "function" "Functions" )
+
+ #writeSummary($obj.event "event" "Event")
+ #writeSummary($obj.ifunction "ifunction" "Function Interface")
+#end
+
+#macro(writeLogicalContainerDetails $obj)
+ #writeDetails($obj "variable" "Variable")
+ #writeDetails($obj "property" "Property")
+ #writeDetails($obj "constructor" "Constructor")
+ #writeDetails($obj "function" "Function")
+ #writeDetails($obj "event" "Event")
+ #writeDetails($obj "ifunction" "Function Interface")
+#end
+
+#macro(writeContainer $obj)
+ #if($obj.comment.srcUrl)
+ view source
+ #end
+ $obj.capCommentType $obj.comment.name
+
+ #writeClassAttributes($obj)
+
+
+
+
+ $obj.comment.modifiers
+ $obj.commentType
+ $obj.comment.name
+
+
+ #writeModuleAttributes($obj)
+ #if($obj.comment.content)
+
+ #end
+ #genCommonAttrs($obj.comment)
+ #if ($obj.physOwner)
+ Defined in
+ $obj.physOwner.comment.name
+ #end
+
+
+
+ #writeLogicalContainerSummary($obj)
+
+ #writeLogicalContainerDetails($obj)
+#end
+
+#macro(writeOverview $object)
+
+#end
+
+#macro(writeRefOverview $coll $elementType $elementName)
+ #if ($coll.size() > 0)
+ $elementName
+ #foreach($item in $coll)
+ #writeOverview($item)
+ #end
+ #end
+#end
\ No newline at end of file
--
cgit v1.2.3