antville/helma
antville/helma
1
1
Fork 0
Code Issues 5 Pull requests 9 Projects Releases 5 Activity Actions

major overhaul of the manage app's api-documentation functions.

Browse source 
things can now be rendered to static html, new helma features are
supported (prototype extension), everyhting is done in a nice and
clean way with skins.
This commit is contained in:
stefanp 2002-11-21 18:36:03 +00:00
parent 76bbe4053b
commit 7633e98eea
59 changed files with 1052 additions and 578 deletions
Download patch file Download diff file Expand all files Collapse all files

2
DocTag/author.skin Normal file
View file

@ -0,0 +1,2 @@
<li><b>Author</b><br/>
<% this.text %>

2
DocTag/deprecated.skin Normal file
View file

@ -0,0 +1,2 @@
<li><b>Deprecated</b><br/>
<% this.text %>

1
DocTag/main.skin Normal file
View file

@ -0,0 +1 @@
<li><% this.text %>

3
DocTag/overrides.skin Normal file
View file

@ -0,0 +1,3 @@
<li><b>Overrides</b><br/>
<% param.link %>

2
DocTag/parameter.skin Normal file
View file

@ -0,0 +1,2 @@
<li><b>Parameter</b> <code><% this.name %></code>:<br/>
<% this.text %>

46
DocTag/renderfunctions.js
View file

@ -1,46 +0,0 @@
/**
* function renders list of tags, language is hardcoded here
* @arg number of current argument (for formatting arg1, arg2 etc)
* @arg method method-object from which we try to find other prototypes/methods
* when we're formatting a see tag
*/
function render(argCt,docFunc) {
var str = "";
if ( this.getKind() == this.ARG ) {
str = "<b>arg" + argCt + ":</b> " + format(this.text);
} else if ( this.getKind() == this.PARAM ) {
str = "<b>Parameter " + this.name;
if ( this.text!=null && this.text!="" ) {
str += ":</b> " + format(this.text);
}
} else if ( this.getKind() == this.RETURNS ) {
str = "<b>Returns:</b> " + format(this.text);
} else if ( this.getKind() == this.AUTHOR ) {
str = "<b>by " + format(this.text) + "</b>";
} else if ( this.getKind() == this.VERSION ) {
str = "<b>Version " + format(this.text) + "</b>";
} else if ( this.getKind() == this.RELEASE ) {
str = "<b>since" + format(this.text) + "</b>";
} else if ( this.getKind() == this.SEE ) {
if ( this.text.indexOf("http://")==0 ) {
str = '<a href="' + this.text + '">' + this.text + '</a>';
} else {
var tmp = new java.lang.String(this.text);
tmp = tmp.trim();
var arr = tmp.split(".");
var obj = docFunc.getApplication().getDocPrototype(arr[0]);
if( arr.length>1 && obj.getFunction(arr[1])!=null ) {
str = '<b>See also: <a href="' + obj.href("main") + '#' + obj.getFunction(arr[1]).name + '">' + format(tmp) + '</a></b>';
} else if ( obj!=null ) {
str = '<b>See also: <a href="' + obj.href("main") + '">' + format(tmp) + '</a></b>';
}
}
if ( str=="" ) {
str = "<b>See also:</b> " + format(this.text);
}
}
return str + "<br />";
}

2
DocTag/return.skin Normal file
View file

@ -0,0 +1,2 @@
<li><b>Returns</b><br>
<% this.text %>

2
DocTag/see.skin Normal file
View file

@ -0,0 +1,2 @@
<li><b>See also</b><br>
<% param.link %>