[ibis-macro] comment sample
- From: "Mike LaBonte (milabont)" <milabont@xxxxxxxxx>
- To: <ibis-macro@xxxxxxxxxxxxx>
- Date: Tue, 6 Sep 2005 13:06:18 -0400
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
Other related posts:
