I guess we should come up with a commenting standard. I started to document
dynlayer.js.
A sample of my commenting style:
/**
DynAPI Distribution
DynLayer Class
DynLayer.js v1.71 Sun Nov 11 16:25:18 2001 UTC
The DynAPI Distribution is distributed under the terms of the GNU LGPL
license.
The DynLayer inherits all methods and properties from DynObject.
The DynLayer is the standard class used to manipulate "layers".
*/
/**
Public Method
void setClip (int clip[])
Sets the DynLayer's clipped area bound on its 4 sides
based on its absolute css position, using the 4 interger
values passed to the method.
(top,right,bottom,left)
Requires 4 intergers
*/
DynLayer.prototype.setClip=function(clip) {
var cc=this.getClip();
for (var i=0;i<clip.length;i++) if (clip[i]==null) clip[i]=cc[i];
this.clip=clip;
if (this.css==null) return;
var c=this.css.clip;
if (is.ns4) c.top=clip[0], c.right=clip[1], c.bottom=clip[2],
c.left=clip[3];
else this.css.clip="rect("+clip[0]+"px "+clip[1]+"px "+clip[2]+"px
"+clip[3]+"px)";
};
/**
Public Method
int getClip ()
Returns the DynLayer's clipped area bound on its 4 sides
based on its absolute css position.
(top,right,bottom,left)
Returns 4 intergers
*/
DynLayer.prototype.getClip=function() {
if (this.css==null || !this.css.clip) return [0,0,0,0];
var c = this.css.clip;
if (c) {
if (is.ns4) return [c.top,c.right,c.bottom,c.left];
if (c.indexOf("rect(")>-1) {
c=c.split("rect(")[1].split(")")[0].split("px");
for (var i=0;i<c.length;i++) c[i]=parseInt(c[i]);
return [c[0],c[1],c[2],c[3]];
}
else return [0,this.w,this.h,0];
}
};
What does everyone think of this comment style? Anything we need to add,
subtract from it? Once we agree on a style we can split up the files and do
the grunt work. Since we've agreed to use doxygen, I would like to hear from
experienced doxygen users as to what would be nice to have in the comment
style.
NanoFace =;^)
-----Original Message-----
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]]On Behalf Of Matt Fair
Sent: November 16, 2001 2:40 PM
To: [EMAIL PROTECTED]
Subject: [Dynapi-Dev] dynapi documentation
So is it decided that we will be using Doxygen?
I would like to help out with the documentation effort.
What needs to be done in the effort?
How can people help?
Matt
_______________________________________________
Dynapi-Dev mailing list
[EMAIL PROTECTED]
http://www.mail-archive.com/[email protected]/
_______________________________________________
Dynapi-Dev mailing list
[EMAIL PROTECTED]
http://www.mail-archive.com/[email protected]/
