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/css/jgdoc.css | 301 +++++++++ .../jGrouseDoc/skins/common/css/jgindex.css | 53 ++ .../jGrouseDoc/skins/common/img/closed.gif | Bin 0 -> 104 bytes .../jGrouseDoc/skins/common/img/closedLarge.gif | Bin 0 -> 132 bytes buildscripts/jGrouseDoc/skins/common/img/node.gif | Bin 0 -> 106 bytes buildscripts/jGrouseDoc/skins/common/img/open.gif | Bin 0 -> 101 bytes .../jGrouseDoc/skins/common/img/openLarge.gif | Bin 0 -> 128 bytes buildscripts/jGrouseDoc/skins/common/js/jgdoc.js | 239 +++++++ buildscripts/jGrouseDoc/skins/common/js/jgindex.js | 96 +++ buildscripts/jGrouseDoc/skins/common/js/navTree.js | 213 +++++++ buildscripts/jGrouseDoc/skins/common/vm/common.vm | 604 ++++++++++++++++++ .../jGrouseDoc/skins/common/xslt/common.xslt | 704 +++++++++++++++++++++ 12 files changed, 2210 insertions(+) create mode 100644 buildscripts/jGrouseDoc/skins/common/css/jgdoc.css create mode 100644 buildscripts/jGrouseDoc/skins/common/css/jgindex.css create mode 100644 buildscripts/jGrouseDoc/skins/common/img/closed.gif create mode 100644 buildscripts/jGrouseDoc/skins/common/img/closedLarge.gif create mode 100644 buildscripts/jGrouseDoc/skins/common/img/node.gif create mode 100644 buildscripts/jGrouseDoc/skins/common/img/open.gif create mode 100644 buildscripts/jGrouseDoc/skins/common/img/openLarge.gif create mode 100644 buildscripts/jGrouseDoc/skins/common/js/jgdoc.js create mode 100644 buildscripts/jGrouseDoc/skins/common/js/jgindex.js create mode 100644 buildscripts/jGrouseDoc/skins/common/js/navTree.js create mode 100644 buildscripts/jGrouseDoc/skins/common/vm/common.vm create mode 100644 buildscripts/jGrouseDoc/skins/common/xslt/common.xslt (limited to 'buildscripts/jGrouseDoc/skins/common') diff --git a/buildscripts/jGrouseDoc/skins/common/css/jgdoc.css b/buildscripts/jGrouseDoc/skins/common/css/jgdoc.css new file mode 100644 index 00000000..a56481d5 --- /dev/null +++ b/buildscripts/jGrouseDoc/skins/common/css/jgdoc.css @@ -0,0 +1,301 @@ + +@CHARSET "ISO-8859-1"; +/* + jGrouseDoc stylesheet file. + @Copyright (c) 2007 by Denis Riabtchik. All rights reserved. See license.txt and http://jgrouse.com for details@ + $Id: jgdoc.css 340 2008-01-21 16:13:59Z broofa $ +*/ + +body +{ + /*font-family: Helvetica,Arial,sans-serif; + font-size: 0.9em;*/ +} + + +a +{ + text-decoration: none; +} + +.overviewTitle +{ + font-weight: bold; + font-size: 1.3em; + padding-top: 1em; + clear: both; +} + +.overviewItem +{ +} + + +.overviewSectionHeader +{ + font-weight: bold; + font-size: 1.1em; + padding-top: 0.5em; +} + +.sectionHeader +{ + border: 2px groove black; + font-size: 1.7em; + text-align: left; + font-weight: bold; + background-color: #ccccff; + color: black; + padding: 3px; +} + +.logicalSummary +{ +} + +.summaryTable +{ + border: 2px groove black; +} + +.summaryTableHeader +{ + font-size: 1.7em; + text-align: left; + font-weight: bold; + background-color: #ccccff; + color: black; + padding: 4px; +} + +.summaryTable .summaryItem +{ + border-top: 1px solid; + padding: 2px; +} + +.summaryTable .summaryItemRef +{ + font-weight: bold; +} + +.summaryTable .summaryItemDef +{ +} + +.summaryTable .inheritanceSummary +{ + border-top: 1px solid; + padding: 2px; +} + +.summaryTable .summaryItemDesc +{ + padding-left: 2em; +} + +.elementName +{ + font-weight: bold; +} + +.descSection +{ + font-weight: bold; +} + + +.navbar +{ + font-size: 0.9em; + padding-bottom: 4px; +} + +.currentPage +{ + font-weight: bold; +} + +.navbaritem +{ + float: left; + width: 10em; + background-color: #ccccff; + color: black; + padding: 4px; + margin: 2px; + padding-top: 2px; + padding-bottom: 2px; + text-align: center; +} + +.navbaritem a +{ + background-color: #ccccff; + color: black; + text-decoration: underline; +} + + +.projectDescRef +{ + font-weight: bold; +} + +.paddedDetails +{ + padding-left: 5em; +} + +.example +{ + font-size: 0.8em; + font-family: courier; + white-space: pre; +} + + + +.searchItem +{ + cursor: pointer; +} + +.jgdSelectedItem +{ + background-color: #0a246a; + color: white; +} + +.jgdSearchRect +{ + width:60%; + height:20em; + border: 2px inset; + overflow: auto; +} + +.jgdSearchString +{ + width:60%; +} + +.jgsInfo +{ + white-space: pre +} + + + +/*---------- NavTree ----------------*/ + + +#content { + font-size: .9em; + line-height:1.6; +} +.navTree a { + text-decoration: none; +} +.navTree a:hover { + text-decoration: underline; +} + +.navTree .contents +{ + list-style: none; + padding-left: 6px; + margin-left: 0px; + clear: both; +} + +.navTree .contents li +{ + clear: both; + white-space: nowrap; +} + + +.navTree .contents ul +{ + border-left: 1px solid #cccccc; + margin-left: 6px; + clear: both; +} + + +.navTree .contents span.node +{ + display: block; + float: left; +} + +.navTree span.node +{ + cursor: pointer; + background-repeat: no-repeat; + background-position: 0em 0.2em; +} + +.navTree .open span.node +{ + background-image: url(open.gif) ; +} + +.navTree .closed span.node +{ + background-image: url(closed.gif) ; +} + +.navTree .leaf span.node +{ + background-image: url(node.gif) ; +} + +.navTree .closed .contents +{ + display: none; +} + +.navTree .markerSpace +{ + padding-left: 12px; +} + +.navTree .openAll, +.navTree .closeAll { + font-size: .9em; + background-repeat: no-repeat; + padding-left: 16px; + padding-right: 7px; + background-position: left center; + cursor: pointer; +} + +.navTree .openAll { + background-image: url(openLarge.gif); +} + +.navTree .closeAll +{ + background-image: url(closedLarge.gif); +} + +.comment +{ + padding-top: 0.5em; + padding-bottom: 0.5em; +} + +ul.paramoption +{ + margin-top: 0px; + margin-bottom: 0px; +} + +a.srcUrlLink +{ + color:#66f; + float: right; + font-size: 11px; +} diff --git a/buildscripts/jGrouseDoc/skins/common/css/jgindex.css b/buildscripts/jGrouseDoc/skins/common/css/jgindex.css new file mode 100644 index 00000000..c113487f --- /dev/null +++ b/buildscripts/jGrouseDoc/skins/common/css/jgindex.css @@ -0,0 +1,53 @@ +/* + jGrouseDoc stylesheet file for index page. + Copyright (c) 2007 by Robert Kieffer and jGrouseDoc contributors + $Id: jgindex.css 302 2007-12-24 22:51:11Z denis.riabtchik $ +*/ +@CHARSET "ISO-8859-1"; + + dt { + clear:both; + float:left; + width: 200px; + margin-left: 20px; + } + a { + color: #009; + text-decoration: none; + } + a:hover { + color: #009; + text-decoration: underline; + } + dd { + /*float:left;*/ + } + dt, dd { + margin: 0px; + } + dt.even, dd.even { + border-bottom: dashed 1px #ddd; + } + dt.odd, dd.odd { + border-bottom: dotted 1px #eee; + } + dt.is_namespace { + font-weight:bold; + } + + #toc { + font-size: 12pt; + font-weight: bold; + } + #toc .has_entries a, + #toc .no_entries {padding: 0px 3px;} + #toc .no_entries {color:#999} + + .letter_section { + clear:both; + margin: 0px; + padding:15px 0px 6px; + } + .letter_section a { + color:#000; + } diff --git a/buildscripts/jGrouseDoc/skins/common/img/closed.gif b/buildscripts/jGrouseDoc/skins/common/img/closed.gif new file mode 100644 index 00000000..ab9701f2 Binary files /dev/null and b/buildscripts/jGrouseDoc/skins/common/img/closed.gif differ diff --git a/buildscripts/jGrouseDoc/skins/common/img/closedLarge.gif b/buildscripts/jGrouseDoc/skins/common/img/closedLarge.gif new file mode 100644 index 00000000..97e3ab95 Binary files /dev/null and b/buildscripts/jGrouseDoc/skins/common/img/closedLarge.gif differ diff --git a/buildscripts/jGrouseDoc/skins/common/img/node.gif b/buildscripts/jGrouseDoc/skins/common/img/node.gif new file mode 100644 index 00000000..82362651 Binary files /dev/null and b/buildscripts/jGrouseDoc/skins/common/img/node.gif differ diff --git a/buildscripts/jGrouseDoc/skins/common/img/open.gif b/buildscripts/jGrouseDoc/skins/common/img/open.gif new file mode 100644 index 00000000..01286477 Binary files /dev/null and b/buildscripts/jGrouseDoc/skins/common/img/open.gif differ diff --git a/buildscripts/jGrouseDoc/skins/common/img/openLarge.gif b/buildscripts/jGrouseDoc/skins/common/img/openLarge.gif new file mode 100644 index 00000000..d4162470 Binary files /dev/null and b/buildscripts/jGrouseDoc/skins/common/img/openLarge.gif differ diff --git a/buildscripts/jGrouseDoc/skins/common/js/jgdoc.js b/buildscripts/jGrouseDoc/skins/common/js/jgdoc.js new file mode 100644 index 00000000..0687c039 --- /dev/null +++ b/buildscripts/jGrouseDoc/skins/common/js/jgdoc.js @@ -0,0 +1,239 @@ +/** + * Searcher for JGrouseDoc + * $Id: jgdoc.js 324 2008-01-06 16:44:39Z denis.riabtchik $ + */ + +jgdoc = {} + +jgdoc.Searcher = +{ + initialize : function() + { + this._searchBox = document.getElementById("jgsSearchString"); + this._searchResults = document.getElementById("jgsSearchResults"); + this._info = document.getElementById("jgsInfo"); + this._currentValue = ""; + this._currentItems = []; + this._currentItem = -1; + this._data = null; + return this; + }, + + _getEvent : function(event) + { + return window.event? window.event : event; + }, + + _getTarget : function(event) + { + return event.target || event.srcElement + }, + + addClass : function(element, className) + { + var s = element.className; + var a = s.split(' '); + for (var i = 0; i < a.length; i++) + { + if (a[i] == className) + { + return; + } + } + a.push(className); + element.className = a.join(' '); + }, + + removeClass : function(element, className) + { + var s = element.className; + var a = s.split(' '); + for (var i = 0; i < a.length; i++) + { + if (a[i] == className) + { + a.splice(i, 1); + break; + } + } + element.className = a.join(' '); + + }, + + dispatcher : function(event) + { + if (this != jgdoc.Searcher) + { + arguments.callee.apply(jgdoc.Searcher, arguments) + return; + } + event = this._getEvent(event); + var type = event.type; + var handler = "on" + type; + this[handler](event, this._getTarget(event)); + }, + + onclick : function(event, target) + { + window.location.href = target._data.ref; + }, + + onmouseover : function(event, target) + { + this.selectItem(target.index); + }, + + onmouseout : function(event, target) + { + this.unselectItem(target.index); + }, + + selectItem : function(index) + { + if (index != this._currentItem) + { + this._currentItem = index; + var item = this._currentItems[index]; + this.addClass(item, 'jgdSelectedItem'); + var text = item._data.summary.split('\n').join('
'); + this._info.innerHTML = text; + } + }, + + unselectItem : function(index) + { + this._currentItem = -1; + var item = this._currentItems[index]; + this.removeClass(item, 'jgdSelectedItem'); + this._info.innerHTML = ''; + }, + + + onTimer : function() + { + if (this != jgdoc.Searcher) + { + arguments.callee.apply(jgdoc.Searcher, arguments) + return; + } + var val = this._searchBox.value; + if (val != this._currentValue) + { + this._currentValue = val; + this.redraw(); + } + }, + + setData : function(data) + { + this._data = data; + this.redraw(); + this._searchBox.focus(); + }, + + addListener : function(element, eventName, handler) + { + if (element.addEventListener) + { + element.addEventListener(eventName, handler, false); + } + else + { + element.attachEvent('on' + eventName, handler); + } + }, + + removeListener : function(element, eventName, handler) + { + if (element.removeEventListener) + { + element.removeEventListener(eventName, handler, false); + } + else + { + element.detachEvent('on' + eventName, handler); + } + }, + + findMatches : function() + { + var result = []; + if (this._currentValue) + { + var v = this._currentValue.toUpperCase(); + for (var i = 0; i < this._data.length; i++) + { + var item = this._data[i]; + if (item.localName.toUpperCase().indexOf(v) == 0) + { + result.push(item); + } + } + } + return result; + }, + + + clearItem : function(item) + { + item._data = null; + this.removeListener(item, 'click', this.dispatcher); + this.removeListener(item, 'mouseover', this.dispatcher); + this.removeListener(item, 'mouseout', this.dispatcher); + }, + + clear : function() + { + for (var i = 0; i < this._currentItems.length; i++) + { + this.clearItem(this._currentItems[i]); + } + this._currentItems = []; + this._searchResults.innerHTML = ""; + this._currentItem = -1; + }, + + + createItem : function(item, index) + { + var d = document.createElement("div"); + d.className = "searchItem"; + //d.title = item.summary; + d.innerHTML = item.fullName; + d.index = index; + d._data = item; + this.addListener(d, 'click', this.dispatcher); + this.addListener(d, 'mouseover', this.dispatcher); + this.addListener(d, 'mouseout', this.dispatcher); + //todo - set listeners + return d; + }, + + redraw : function() + { + this.clear(); + var res = this.findMatches(); + if (res.length > 0) + { + for (var i = 0; i < res.length; i++) + { + var d = this.createItem(res[i], i); + this._currentItems.push(d); + this._searchResults.appendChild(d); + } + } + else + { + var s = (this._currentValue)? "Not found" : "Start typing the name of the item"; + this._searchResults.innerHTML = s; + } + }, + + start : function() + { + var instance = jgdoc.Searcher.initialize(); + instance.setData([]); + instance._timer = window.setInterval(instance.onTimer, 100); + } +} + diff --git a/buildscripts/jGrouseDoc/skins/common/js/jgindex.js b/buildscripts/jGrouseDoc/skins/common/js/jgindex.js new file mode 100644 index 00000000..5a0bf2de --- /dev/null +++ b/buildscripts/jGrouseDoc/skins/common/js/jgindex.js @@ -0,0 +1,96 @@ +/** + * Script that builds jGrouseDoc Index Page + * Copyright (c) 2007 by Robert Kieffer and jGrouseDoc contributors + * $Id: jgindex.js 303 2007-12-24 22:52:30Z denis.riabtchik $ + */ + +var jgindex = { + load: function() { + // Sort data by localName + jgindex.data.sort(function(a,b) { + var c = (a.localName || a.fullName).toLowerCase(); + var d = (b.localName || b.fullName).toLowerCase(); + return c < d ? -1 : (c > d ? 1 : 0); + }); + + // Now render the index + jgindex.renderEntries(); + }, + + renderEntries: function() { + var h = []; + + // Use a DL, since this is the most semantically correct structure + h.push('
'); + + // Hash to track which letters have entries + var letters = {}; + + // Loop through each entry + for (var i = 0; i < jgindex.data.length; i++) { + var entry = jgindex.data[i]; + + // Get name/url for the entry's namespace + var srcName = entry.parent; + var srcLink = entry.ref.replace(/#.*/, ''); + + // Apply odd/even classname (makes styling even/odd rows easy) + var cn = [(i % 2) ? 'odd' : 'even']; + cn.push(/^(class|interface|struct|object)/.test(entry.summary) ? 'is_namespace' : 'is_not_namespace'); + + // Get the entry's first letter + var ln = entry.localName || entry.fullName || '_unnamed'; + var letter = ln.charAt(0).toUpperCase(); + + // ... and see if it's the first one for that letter + if (!letters[letter]) { + letters[letter] = true; + } else { + letter = null; + } + + // ... and if it is, render the section header + if (letter) { + h.push('

' + letter + '

'); + } + + // Render the entry's HTML + cn = cn.join(' '); + h.push( + '
' + + '' + ln + '' + + '
' + + '
' + + '' + srcName + '' + + '
' + ); + } + h.push('
'); + + // Stick it all into the element + document.getElementById('index').innerHTML = h.join('\n'); + + // Render the letters table-of-contents at the top + h = []; + var toc = '$_ABCDEFGHIJKLMNOPQRSTUVWXYZ'; + for (var i = 0; i < toc.length; i++) { + var letter = toc.charAt(i); + h.push(letters[letter] ? + '' + letter + '' : + '' + letter + '' + ); + } + document.getElementById('toc').innerHTML = h.join('\n'); + } +} + + +// Hack so we can get access to the index data +var jgdoc = { + Searcher: { + setData: function(data) { + jgindex.data = data; + jgindex.load(); + } + } +} diff --git a/buildscripts/jGrouseDoc/skins/common/js/navTree.js b/buildscripts/jGrouseDoc/skins/common/js/navTree.js new file mode 100644 index 00000000..f0c4f133 --- /dev/null +++ b/buildscripts/jGrouseDoc/skins/common/js/navTree.js @@ -0,0 +1,213 @@ +jgdoc = {}; +jgdoc.TreeItem = function(nodeName, item) +{ + this._nodeName = nodeName; + this._data = item; + this._children = []; + +} + +jgdoc.Searcher = +{ + setData : function(data) { + this._data = data; + this.processItems(); + this.render(); + }, + + sorter: function(o1, o2) { + var l1 = o1.localName; + var l2 = o2.localName; + return l1 < l2? -1 : (l1 > l2 ? 1 : 0); + }, + + processItems : function() { + var root; + + // Pass 1: Build index by fullName, and locate the root element + this._byName = {}; + for (var i = 0; i < this._data.length; i++) { + var d = this._data[i]; + if (d.fullName == "GLOBAL") { + root = this._root = d; + } + this._byName[d.fullName] = d; + } + + // Pass 2: Populate _children arrays + for (var i = 0; i < this._data.length; i++) { + var item = this._data[i]; + if (item.elementType == "logical_container" && item != this._root) { + var parent = this._byName[item.parent]; + parent._children = parent._children || []; + parent._children.push(item); + } + } + }, + + addClass : function(element, className) + { + var s = element.className; + var a = s.split(' '); + for (var i = 0; i < a.length; i++) + { + if (a[i] == className) + { + return; + } + } + a.push(className); + element.className = a.join(' '); + }, + + removeClass : function(element, className) + { + var s = element.className; + var a = s.split(' '); + var found = false; + for (var i = 0; i < a.length; i++) + { + if (a[i] == className) + { + a.splice(i, 1); + found = true; + break; + } + } + element.className = a.join(' '); + return found; + }, + + clicked : function(event) + { + event = window.event? window.event : event; + var target = event.target || event.srcElement; + var span = target.parentNode; + var li = span.parentNode; + var wasOpen = jgdoc.Searcher.removeClass(li, 'open'); + if (wasOpen) + { + jgdoc.Searcher.addClass(li, 'closed'); + } + else + { + jgdoc.Searcher.removeClass(li, 'closed'); + jgdoc.Searcher.addClass(li, 'open'); + } + span.title = "Click to " + (wasOpen? "expand" : "collapse"); + + }, + + addListener : function(element, eventName, handler) + { + if (element.addEventListener) + { + element.addEventListener(eventName, handler, false); + } + else + { + element.attachEvent('on' + eventName, handler); + } + }, + + removeListener : function(element, eventName, handler) + { + if (element.removeEventListener) + { + element.removeEventListener(eventName, handler, false); + } + else + { + element.detachEvent('on' + eventName, handler); + } + }, + + + render : function() + { + var d = document.getElementById('content'); + d.innerHTML = ''; + var athis = this; + function renderNode(item) + { + var node = document.createElement('li'); + node.className = item.type; + node.innerHTML = " " + item.localName + ""; + var span = node.firstChild; + var img = span.firstChild; + athis.addListener(img, 'mousedown', athis.clicked); + if (item._children) + { + item._children.sort(jgdoc.Searcher.sorter); + node.className += (item == athis._root)? ' open' : ' closed'; + span.title = "Click to " + (item != athis._root? 'expand' : 'collapse'); + var subnode = document.createElement("ul"); + subnode.className = 'contents'; + for (var i = 0; i < item._children.length; i++) + { + var child = renderNode(item._children[i]); + subnode.appendChild(child); + } + node.appendChild(subnode); + } + else + { + node.className += ' leaf'; + } + item._node = node; + return node; + } + var root = renderNode(this._root); + d.appendChild(root); + }, + + cancelEvent : function(event) + { + if (event.preventDefault) + { + event.preventDefault(); + event.stopPropagation(); + } + else + { + event.preventDefault(); + event.stopPropagation(); + } + }, + + switchAll : function(doOpen) + { + var ac = doOpen? 'open' : 'closed'; + var rc = doOpen? 'closed' : 'open'; + + var athis = this; + + function doSwitchNode(anode) + { + if (anode._children) + { + if (doOpen || anode != athis._root) + { + athis.removeClass(anode._node, rc); + athis.addClass(anode._node, ac); + } + for (var i = 0; i < anode._children.length; i++) + { + doSwitchNode(anode._children[i]); + } + } + } + doSwitchNode(this._root); + }, + + onOpenAll : function() + { + jgdoc.Searcher.switchAll(true); + }, + + onCloseAll : function() + { + jgdoc.Searcher.switchAll(false); + } + +}; 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) + + #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) +

    + + $memberType + $func.localName + +

    + #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 +
    + #writeContent($funcItself.comment.content) +
    + #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) + + #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) +

    + + $var.commentType $varModifiers + #writeType($varItself.comment.typeLink) + $var.localName + +

    +
    + #writeContent($varItself.comment.content) +
    + #genCommonAttrs($varItself.comment) + #writePhysOwner($var) +
    +#end + + + + +#macro(writeLegacies $obj $memberType $memberName ) + #foreach($legacy in $obj.legacies) + #if ($legacy.get($memberType).size() > 0) +
    +
    + $memberName inherited from $legacy.ancestor.fullName +
    +
    + #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 +
    + $varModifiers + #writeType($variable.comment.typeLink) + $variable.localName +
    +
    + #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) +
    + + $class.comment.name + +
    +
    + #writeContent($class.comment.summary) +
    +#end + + +#macro(writeSummary $coll $elemType $elemName) + #if($coll.size() != 0) +
    +
    + $elemName Summary +
    + #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) +

    +

    $memberName Details

    + #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) + + +#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) +
    #writeContent($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) +

    + + $object.fullName + +
    +#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 diff --git a/buildscripts/jGrouseDoc/skins/common/xslt/common.xslt b/buildscripts/jGrouseDoc/skins/common/xslt/common.xslt new file mode 100644 index 00000000..b8477c76 --- /dev/null +++ b/buildscripts/jGrouseDoc/skins/common/xslt/common.xslt @@ -0,0 +1,704 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    +
    +
    + +
    + + + + + + + + + + + () +
    +
    +
    +
    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    +
    + +
    +
    + + +
    + + logical/.html + + +
    +
    + +
    +
    + + + + (, []) + + + + + + physical/ + logical/ + + + .html + + + + .html#___ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Authors: + +
    +
    +
    +
    + +
    + See also: + +
    +
    +
    +
    + +
    + Version: +
    +
    +
    + +
    + Generated on: +
    +
    +
    + +
    + Since: +
    +
    +
    + +
    + Deprecated +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + +
    + + physical/.html + + +
    +
    + &nbsp; +
    +
    + + + + + + + + + + + + + + + summaryTable + + +
    + Summary +
    + +
    + + + +
    +
    +
    +

    + + + + + +

    + + + + + + + classFrame + + + + + + + + + +
    +
    + + + + + +
    + + + + + +
    +
    + + + no + + + + + no + + + + + + + +
    +
    + inherited from + + + + + + + + +
    +
    + + + , + + + + + + + + + + + +
    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + false + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    + + ___ + + + + +

    +
    + +
    + + + + +
    +
    + + +
    + [] + + +
      + +
    +
    +
    +
    + + + + + + + +
  • + + [ + + + + ] + + +
  • +
    + + + + srcUrlLink + + view source + + + + + + + + +

    + + ___ + + + + +

    + + + +
    + + + + + + + + + + +
    +
    +
    + +
    + + + + + () + +
    +
    +
    +
    + +
    + +
    + Parameters:
    + +
    + +
    +
    + +
    +
    +
    +
    + +
    + Returns:
    +
    + + +
      + +
    +
    +
    +
    +
    + +
    + Throws:
    + +
    +
    +
    +
    + + + + + + +
    +
    + + + + + + + + + details +

    Details

    + + + + + true + + +
    +
    +
    + + + + + + + + + + Defined in + + physical/.html + + + + + + + + + + stylesheet + text/css + jgdoc.css + + + stylesheet + text/css + theme.css + + + + stylesheet + text/css + + + + + + +
    -- cgit v1.2.3