[ibis-macro] Re: comment sample
- From: "Muranyi, Arpad" <arpad.muranyi@xxxxxxxxx>
- To: <ibis-macro@xxxxxxxxxxxxx>
- Date: Tue, 6 Sep 2005 10:16:41 -0700
Mike,
This is pretty good. I have a few comments:
1) I would change the description of the terminals a little
to indicate that "p" stands for the positive terminal, and
"n" for the negative terminal (instead of using the words
"the other").
2) Instead of "examples" I would say something like "Call as:"
and below that with the SPICE code I would somehow indicate
that for substitution the equivalent SPICE call may look
like that.
3) I remember you had some really good ideas about using XML
for IBIS purposes. Would you consider applying those here?
I have seen documentation of Software Development Kits (SDK)
where they would put comments like this in the code using
XML, and the browser would pick it up making the whole thing
searchable, etc...
Arpad
================================================================
-----Original Message-----
From: ibis-macro-bounce@xxxxxxxxxxxxx [mailto:ibis-macro-bounce@xxxxxxxxxxxxx]
On Behalf Of Mike LaBonte (milabont)
Sent: Tuesday, September 06, 2005 10:06 AM
To: ibis-macro@xxxxxxxxxxxxx
Subject: [ibis-macro] comment sample
Here is an example of how we might document library modules. Once we
agree on the format I'll knock off all the others.
Mike
//====================================================================
//
// MODULE: IBIS_R (p, n)
// TERMINALS:
// p A resistor terminal.
// n The other resistor terminal.
// PARAMETERS:
// Rval Resistance value.
// Scale Scaling factor for resistance value.
// DESCRIPTION:
// A simple resistor. The resistor value is calculated:
// R = Rval * Scale
//
// EXAMPLES:
// VAMS: IBIS_R #(.Rval(100)) R1 (clk_n, clk_p);
// SPICE: R1 clk_n clkp IBIS_R Rval=100
//
//====================================================================
module IBIS_R (p, n);
electrical p, n;
branch (p, n) Out;
parameter real Rval = 1.0;
parameter real Scale = 1.0;
analog begin
V(Out) <+ Scale * Rval * I(Out);
end
endmodule
---------------------------------------------------------------------
IBIS Macro website: http://www.sisoft.com/ibis-macro
IBIS Macro archives: //www.freelists.org/archives/ibis-macro
To unsubscribe send an email:
To: ibis-macro-request@xxxxxxxxxxxxx
Subject: unsubscribe
---------------------------------------------------------------------
IBIS Macro website: http://www.sisoft.com/ibis-macro
IBIS Macro archives: //www.freelists.org/archives/ibis-macro
To unsubscribe send an email:
To: ibis-macro-request@xxxxxxxxxxxxx
Subject: unsubscribe
Other related posts:
