From 85540c9a58359e1e261c04e304d59c2ba2661d8e Mon Sep 17 00:00:00 2001 From: Jean-Paul Chaput Date: Wed, 13 Nov 2019 23:43:04 +0100 Subject: [PATCH] Added capacitor documentation in Oroshi, and generated. --- oroshi/doc/doxyfile | 12 +- oroshi/doc/html/annotated.html | 14 +- oroshi/doc/html/classes.html | 21 +- ...classpython_1_1Stack_1_1Stack-members.html | 2 +- .../html/classpython_1_1Stack_1_1Stack.html | 4 +- .../dir_7837fde3ab9c1fb2fc5be7b717af8d79.html | 2 +- oroshi/doc/html/formula.repository | 18 + oroshi/doc/html/functions.html | 236 +++++++- oroshi/doc/html/functions_func.html | 236 +++++++- oroshi/doc/html/graph_legend.html | 2 +- oroshi/doc/html/index.html | 2 +- oroshi/doc/html/katabatic.tag | 540 ++++++++++++++++++ oroshi/doc/html/menudata.js | 17 +- oroshi/doc/latex/annotated.tex | 4 + .../latex/classpython_1_1Stack_1_1Stack.tex | 2 +- oroshi/doc/latex/refman.tex | 8 +- 16 files changed, 1088 insertions(+), 32 deletions(-) diff --git a/oroshi/doc/doxyfile b/oroshi/doc/doxyfile index 72a4e0c9..026f58f9 100644 --- a/oroshi/doc/doxyfile +++ b/oroshi/doc/doxyfile @@ -107,10 +107,14 @@ WARN_LOGFILE = # Configuration options related to the input files INPUT = \ - ../python/Stack.py \ - ../python/WIP_Transistor.py \ - ../python/WIP_DP.py \ - ../python/WIP_CSP.py + ../python/Stack.py \ + ../python/WIP_Transistor.py \ + ../python/WIP_DP.py \ + ../python/WIP_CSP.py \ + ../python/CapacitorUnit.py \ + ../python/CapacitorMatrix.py \ + ../python/CapacitorRouted.py \ + ../python/CapacitorVRTracks.py FILE_PATTERNS = *.py diff --git a/oroshi/doc/html/annotated.html b/oroshi/doc/html/annotated.html index 62a60ffc..c94fa87f 100644 --- a/oroshi/doc/html/annotated.html +++ b/oroshi/doc/html/annotated.html @@ -43,8 +43,16 @@ $(function() {
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
- - + + + + + + + + + +
 ▼Npython
 ▼NStack
 CStackDraw a Stack of Transistors
 ▼NCapacitorMatrix
 CCapacitorStackDraws the layout of a compact capacitor or a matrix of adjacent identical capacitors
 ▼NCapacitorRouted
 CRoutMatchedCapacitorRouts two matched capacitors, C1 and C2, drawn in a capacitor matrix
 ▼NCapacitorUnit
 CCapacitorUnitDraws a capacitor of type Poly-Poly or Metal-Metal in 350 nm AMS CMOS technology
 ▼NCapacitorVRTracks
 CVerticalRoutingTracksRouts two matched capacitors, C1 and C2, drawn in a capacitor matrix
 ▼NStack
 CStackDraw a Stack of Transistors
@@ -52,7 +60,7 @@ $(function() {
- +
Generated by doxygen 1.8.14 on Mon Oct 28 2019Generated by doxygen 1.8.14 on Wed Nov 13 2019 Return to top of page
diff --git a/oroshi/doc/html/classes.html b/oroshi/doc/html/classes.html index 7711e52d..efb22fc8 100644 --- a/oroshi/doc/html/classes.html +++ b/oroshi/doc/html/classes.html @@ -40,21 +40,28 @@ $(function() {
Class Index
-
s
+
c | r | s | v
- - - + + + + + + +
  s  
-
Stack (python.Stack)   
  c  
+
  s  
+
CapacitorStack (python.CapacitorMatrix)   Stack (python.Stack)   
CapacitorUnit (python.CapacitorUnit)   
  v  
+
  r  
+
VerticalRoutingTracks (python.CapacitorVRTracks)   
RoutMatchedCapacitor (python.CapacitorRouted)   
-
s
+
c | r | s | v

- +
Generated by doxygen 1.8.14 on Mon Oct 28 2019Generated by doxygen 1.8.14 on Wed Nov 13 2019 Return to top of page
diff --git a/oroshi/doc/html/classpython_1_1Stack_1_1Stack-members.html b/oroshi/doc/html/classpython_1_1Stack_1_1Stack-members.html index aa5a1b1e..87b0bb64 100644 --- a/oroshi/doc/html/classpython_1_1Stack_1_1Stack-members.html +++ b/oroshi/doc/html/classpython_1_1Stack_1_1Stack-members.html @@ -56,7 +56,7 @@ $(function() {
- +
Generated by doxygen 1.8.14 on Mon Oct 28 2019Generated by doxygen 1.8.14 on Wed Nov 13 2019 Return to top of page
diff --git a/oroshi/doc/html/classpython_1_1Stack_1_1Stack.html b/oroshi/doc/html/classpython_1_1Stack_1_1Stack.html index c17e8d33..22eb91dd 100644 --- a/oroshi/doc/html/classpython_1_1Stack_1_1Stack.html +++ b/oroshi/doc/html/classpython_1_1Stack_1_1Stack.html @@ -269,7 +269,7 @@ Stack Implementation Details

References Stack.activeBox, Stack.activeOffsetX, Stack.activeOffsetY, Stack.bbHeight, Stack.bbWidth, Stack.botWTracks, Stack.boundingBox, Stack.bulks, Stack.bulkWidth, Stack.computeLayoutParasitics(), Stack.computeStressEffect(), Stack.contactDiffPitch, Stack.contactDiffSide, Stack.DGG, Stack.DGI, Stack.dimensioned, Stack.DMCG, Stack.DMCGT, Stack.DMCI, Stack.eDiffMetal1Width, Bulk.flags, Stack.flags, Stack.gatePitch, Stack.gateVia1Pitch, Stack.getBotTrackY(), Stack.getHorizontalWidth(), Stack.getLastTopTrackY(), Stack.horPitch, Stack.hTrackDistance, Stack.iDiffMetal1Width, Stack.isVH, Stack.L, Stack.metal1ToGate, Stack.metal2Pitch, Stack.metal2TechnoPitch, Stack.metal3Pitch, Stack.metaTransistors, Stack.NERC, Stack.NFs, Stack.NIRC, Stack.sideActiveWidth, Stack.tracksNbPitch(), Stack.vBulkDistance, Stack.verPitch, Stack.w, Stack.wire1Width, Stack.wire2Width, Stack.wire3Width, Stack.wirings, Stack.xpitches, and Stack.ypitches.

-

Referenced by Stack.doLayout(), and Stack.setWirings().

+

Referenced by CapacitorUnit.create(), Stack.doLayout(), RoutMatchedCapacitor.route(), and Stack.setWirings().

@@ -314,7 +314,7 @@ Stack Implementation Details
- +
Generated by doxygen 1.8.14 on Mon Oct 28 2019Generated by doxygen 1.8.14 on Wed Nov 13 2019 Return to top of page
diff --git a/oroshi/doc/html/dir_7837fde3ab9c1fb2fc5be7b717af8d79.html b/oroshi/doc/html/dir_7837fde3ab9c1fb2fc5be7b717af8d79.html index 34810ed0..d5e1942b 100644 --- a/oroshi/doc/html/dir_7837fde3ab9c1fb2fc5be7b717af8d79.html +++ b/oroshi/doc/html/dir_7837fde3ab9c1fb2fc5be7b717af8d79.html @@ -49,7 +49,7 @@ $(function() {
- +
Generated by doxygen 1.8.14 on Mon Oct 28 2019Generated by doxygen 1.8.14 on Wed Nov 13 2019 Return to top of page
diff --git a/oroshi/doc/html/formula.repository b/oroshi/doc/html/formula.repository index 42b59054..f42779c4 100644 --- a/oroshi/doc/html/formula.repository +++ b/oroshi/doc/html/formula.repository @@ -1,2 +1,20 @@ \form#0:$NFs$ \form#1:$ 3 + (NFs-1) \times 2$ +\form#2:$C$ +\form#3:$ C_{a}, C_{p}, A $ +\form#4:$ P $ +\form#5:\[ C = C_{a}A + C_{p}P \] +\form#6:$ C_{a} $ +\form#7:$ C_{p} $ +\form#8:$ femto Farad (fF) $ +\form#9:$ C_1 $ +\form#10:$ C_2 $ +\form#11:$ R*C $ +\form#12:$ 2C+2 $ +\form#13:$ C+1 $ +\form#14:$ [ [1,2], [1,2] ] or [ [2,1], [2,1] ] $ +\form#15:$ C_{00} $ +\form#16:$ C_{01} $ +\form#17:$ m$ +\form#18:$ \mu m$ +\form#19:$ C_{ij} $ diff --git a/oroshi/doc/html/functions.html b/oroshi/doc/html/functions.html index c3262f3f..92e88b1d 100644 --- a/oroshi/doc/html/functions.html +++ b/oroshi/doc/html/functions.html @@ -36,16 +36,244 @@ $(function() {
-
Here is a list of all documented class members with links to the class documentation for each member:
-