summaryrefslogtreecommitdiff
path: root/buildscripts/jGrouseDoc/skins/noframes/vm/jsindex.vm
diff options
context:
space:
mode:
authormikl <>2008-05-06 07:53:08 +0000
committermikl <>2008-05-06 07:53:08 +0000
commitdca8960e21273ed8100fa1fdaeab99ccf141a1f3 (patch)
tree0ae31ef7461dd60686d7e23dcb64ff68bb11ed14 /buildscripts/jGrouseDoc/skins/noframes/vm/jsindex.vm
parentd48e9af1650df7cc17db5042c0b9dc1a3bcf213b (diff)
Imported JS documentor jGrouseDoc-2.0
Diffstat (limited to 'buildscripts/jGrouseDoc/skins/noframes/vm/jsindex.vm')
-rw-r--r--buildscripts/jGrouseDoc/skins/noframes/vm/jsindex.vm57
1 files changed, 57 insertions, 0 deletions
diff --git a/buildscripts/jGrouseDoc/skins/noframes/vm/jsindex.vm b/buildscripts/jGrouseDoc/skins/noframes/vm/jsindex.vm
new file mode 100644
index 00000000..9f1496a0
--- /dev/null
+++ b/buildscripts/jGrouseDoc/skins/noframes/vm/jsindex.vm
@@ -0,0 +1,57 @@
+#macro (writeFunctionJSParams $paramSet)
+#foreach($param in $paramSet.params)#if($velocityCount > 1), #end#if($param.hasModifier('optional'))[#end#if($param.typeLink)$param.typeLink.originalString.trim() #end$param.name#if($param.hasModifier('optional'))]#end#end
+#end
+
+#macro(writeFuncJSSummary $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($funcModifiers.length() > 0)$funcModifiers #end$func.commentType #if ($funcItself.comment.paramSets.size() != 0)#foreach($paramSet in $funcItself.comment.paramSets)#if ($velocityCount > 1)\n#end#if($funcItself.comment.typeLink)$funcItself.comment.typeLink.originalString #end${func.localName}(#writeFunctionJSParams($paramSet))#end
+#else
+#if($funcItself.comment.typeLink)$funcItself.comment.typeLink.originalString #end${funcItself.localName}()#end
+#end
+
+
+#macro(writeVarJSSummary $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
+#if($varModifiers.length() > 0)$varModifiers #end$var.commentType #if($varItself.comment.typeLink)$varItself.comment.typeLink.originalString #end${varItself.localName}#end
+
+#macro(writeContainerJSSummary $cont)
+#if($cont.comment.modifiers.length() > 0)$cont.comment.modifiers #end$cont.commentType $cont.localName#end
+#macro(writeJSSummary $obj)
+#if ($obj.commentType == "variable" || $obj.commentType == "property")#writeVarJSSummary($obj)
+#elseif($obj.commentType == "class" || $obj.commentType == "namespace" || $obj.commentType == "struct" || $obj.commentType == "interface" || $obj.commentType == "object")#writeContainerJSSummary($obj)
+#elseif($obj.commentType == "function" || $obj.commentType == "constructor" || $obj.commentType == "ifunction" || $obj.commentType == "event")#writeFuncJSSummary($obj)#end
+#end
+
+#macro(writeJS $item)
+
+ {
+ localName : "$item.localName",
+ fullName : "$item.fullName",
+ summary : "#writeJSSummary($item)",
+ ref : "#writeLink($item.fullName)",
+ parent : "#if($item.parentName)$item.parentName#end",
+ type : "$item.commentType",
+ elementType : "$item.elementType"
+ }#end
+
+
+
+/*Generated by jGrouseDoc*/
+(function()
+{
+ var data = [#foreach($item in $jg.all())#if($item.commentType != 'file' && $item.commentType != 'module')#if($velocityCount > 1), #end #writeJS($item) #end#end
+ ];
+ jgdoc.setData(data);
+
+})()
+