Imported JS documentor jGrouseDoc-2.0

4 files changed, 229 insertions, 0 deletions

diff --git a/buildscripts/jGrouseDoc/skins/noframes/vm/antgen.vm b/buildscripts/jGrouseDoc/skins/noframes/vm/antgen.vm
new file mode 100644
index 00000000..7ed8671f
--- /dev/null
+++ b/buildscripts/jGrouseDoc/skins/noframes/vm/antgen.vm
@@ -0,0 +1,77 @@
+#if ($jg.project.comment.name)

+	#set($projectName=$jg.project.comment.name.trim())

+#end

+#if ($jg.project.comment.version.size() > 0)

+	#set ($version = $jg.project.comment.version.get(0).content.originalString.trim())

+#end

+#if ($jg.project.comment.description.size() > 0)

+	#set ($projectDesc = $jg.project.comment.description.get(0).content.originalString.trim())

+#end

+#macro (genSummary $coll $pathPart $section)

+    #foreach($le in $coll)

+    	

+        <output file="$outDir/$pathPart/${le.path}.html">

+            <param key="projectName" value="$projectName"/>

+            <param key="projectDesc" value="$projectDesc"/>

+            <param key="version" value="$version"/>

+            #if($aux_css != "not_specified")

+            <param key="aux_css" value="$aux_css"/>

+            #end

+            <param key="objectName" value="$le.fullName"/>

+            <param key="rootPath" value=""/>

+            <param key="navSection" value="$section"/>

+            <param key="trueRootPath" value="../$le.rootPath"/>

+        </output>

+    #end	

+#end

+<?xml version="1.0" encoding="$encoding"?>

+    <!-- Documentation build file for $projectName. Generated by jGrouseDoc-->

+<project name="$projectName" default="applyJGrouseDoc">

+	<target name="applyJGrouseDoc">

+		<copy todir="$outDir" overwrite="yes">

+            <fileset dir="$commonSkin/css" />

+        </copy>

+        <copy todir="$outDir" overwrite="yes">

+            <fileset dir="$skinDir/css" />

+        </copy>

+        <copy todir="$outDir">

+            <fileset dir="$commonSkin/img" />

+        </copy>

+        <copy todir="$outDir" overwrite="yes">

+            <fileset dir="$skinDir/img" />

+        </copy>

+        <copy todir="$outDir" overwrite="yes">

+            <fileset dir="$skinDir/js" />

+        </copy>

+        

+        

+        <vmtask resourcePath="., ${jGrouseHome}" source="${outDir}/${projectFile}" loglevel="INFO">

+            <template templatename="skins/${skin}/vm/jsindex.vm" vmlibs="skins/common/vm/common.vm">

+            	<output file="$outDir/jsindex.js">

+                    <param key="projectName" value="$projectName"/>

+                    <param key="projectDesc" value="$projectDesc"/>

+                    <param key="version" value="$version"/>           

+                    <param key="rootPath" value=""/>     		

+                </output>

+            </template>

+            <template templatename="skins/${skin}/vm/detail.vm" vmlibs="skins/common/vm/common.vm">

+		        <output file="$outDir/index.html">

+		            <param key="projectName" value="$projectName"/>

+		            <param key="projectDesc" value="$projectDesc"/>

+		            <param key="version" value="$version"/>                     

+		            #if($aux_css != "not_specified")

+		            <param key="aux_css" value="$aux_css"/>

+		            #end

+		            <param key="objectName" value="_not_specified_"/>

+		            <param key="navSection" value="logical"/>

+		            <param key="trueRootPath" value=""/>

+		            <param key="rootPath" value=""/>

+		        </output>

+            	

+            	#genSummary($jg.logical "logical" "logical")

+            	#genSummary($jg.files "physical" "file")

+                #genSummary($jg.modules "physical" "module")

+            </template>

+        </vmtask>	        

+    </target>

+</project>

diff --git a/buildscripts/jGrouseDoc/skins/noframes/vm/detail.vm b/buildscripts/jGrouseDoc/skins/noframes/vm/detail.vm
new file mode 100644
index 00000000..8cb95d88
--- /dev/null
+++ b/buildscripts/jGrouseDoc/skins/noframes/vm/detail.vm
@@ -0,0 +1,94 @@
+#if ($jg.get($objectName)) #set ($obj = $jg.get($objectName)) #end

+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

+<html>

+    <head>

+        <title>$projectName</title>

+        <META http-equiv="Content-Type" content="text/html; charset=$encoding">        

+        <script>

+

+			(function()

+			{

+			    var loc = window.location.protocol + '//' + window.location.hostname + window.location.pathname;

+                loc = loc.split('\\');

+                loc = loc.join('/');					    

+			    loc = loc.split('/');

+			    loc.pop();

+			    loc = loc.join('/');

+			    loc += '/' + '$trueRootPath';

+			

+			    document.write("<base href='" + loc + "'></base>");

+			})();

+         

+        </script>

+

+        <link rel="stylesheet" type="text/css" href="${rootPath}jgdoc.css">

+        <link rel="stylesheet" type="text/css" href="${rootPath}theme.css">

+        #if ($aux_css)

+        	<link rel="stylesheet" type="text/css" href="${rootPath}$aux_css">

+        #end

+	    <script type="text/javascript" src="navTree.js"></script>

+	    <script type="text/javascript" src="jgdoc.js"></script>

+	</head>

+    <body>

+        <div class="startup" id="startup">

+            <div class="banner" id="banner">

+                <h1 class="projectName">

+	               <a href=".">$projectName</a>   

+                </h1>

+                <div class="bar">

+	                 version $version

+	            </div>

+	         </div>

+             <div class="content" id="docContent">

+                  <div class="block">

+                        <div id="searchBlock">

+			                <div class="search" >

+			                    <div class="searchLabel">Search:</div>

+			                    <div class="searchBlock" style="height:100%">

+					                <input id="jgsSearchString" type="text" size="60" class="jgdSearchString"/>

+					                <div id="jgsSearchPanel" class="jgsSearchPanel" style="display:none">

+						                <div  class="jgdSearchRect" >

+						                    <div id="jgsSearchResults">

+						                        Loading....

+						                    </div>

+						                </div>

+					                   <div id="jgsInfo" class="jgsInfo" >No selection</div>

+                                    </div>

+                                 </div>

+			                </div>

+		                </div>

+		                <div id="docScroll" class="docScroll">

+		                    <div>

+			                    <hr/>

+						        <div>

+						        #if ($obj)	

+						        	#writeContainer($obj)              

+                                #else

+                                    <hr/>

+                                    #if($jg.project)

+                                    <div class="projectDesc">

+                                        <a name="desc"></a><br/>

+                                        #if($projectDesc && $projectDesc.length() > 0)

+                                        	<h1>$projectDesc</h1>

+                                        #end

+                                        #writeContent($jg.project.comment.content)

+                                        <p />

+                                        #genCommonAttrs($jg.project.comment)

+                                    </div>                                    	

+                                    #end

+                                #end

+						        </div>

+        		          </div>			                    

+		                </div>

+        	       </div>

+             </div>

+             #navigationPane($navSection)

+		</div>	

+	</body>

+    <script type="text/javascript">

+        jgdoc.Searcher.start();

+        jgdoc.NavTree.initialize("#if($obj)$obj.fullName#else'GLOBAL'#end");

+    </script>			

+	<script type="text/javascript" src="jsindex.js">

+    </script>

+</html>

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);

+    

+})()

+    

diff --git a/buildscripts/jGrouseDoc/skins/noframes/vm/test.vm b/buildscripts/jGrouseDoc/skins/noframes/vm/test.vm
new file mode 100644
index 00000000..bde0e031
--- /dev/null
+++ b/buildscripts/jGrouseDoc/skins/noframes/vm/test.vm
@@ -0,0 +1 @@
+$jg.get("_bla").comment.returnsTag
\ No newline at end of file