jcarr
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
coriolis/katabatic/doc/latex/annotated.tex

35 lines
7.2 KiB
TeX
Raw Normal View History

Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\section{Class List}
Merge branch 'devel_stratus' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/CMakeLists.txt documentation/_templates/indexcontent.html documentation/index.rst katana/src/katana/RoutingEvent.h stratus1/CMakeLists.txt
2018-08-19 06:27:09 -05:00
Here are the classes, structs, unions and interfaces with brief descriptions\-:\begin{DoxyCompactList}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} \\*Abstract base class for \hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} }{\pageref{classKatabatic_1_1AutoContact}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoContactHTee}{Auto\-Contact\-H\-Tee} \\*\hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} H-\/\-Tee (two H, one V) }{\pageref{classKatabatic_1_1AutoContactHTee}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoContactTerminal}{Auto\-Contact\-Terminal} \\*\hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} Terminal (S/\-T is a Terminal) }{\pageref{classKatabatic_1_1AutoContactTerminal}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoContactTurn}{Auto\-Contact\-Turn} \\*\hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} Turn (one H, one V) }{\pageref{classKatabatic_1_1AutoContactTurn}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoContactVTee}{Auto\-Contact\-V\-Tee} \\*\hyperlink{classKatabatic_1_1AutoContact}{Auto\-Contact} V-\/\-Tee (one H, two V) }{\pageref{classKatabatic_1_1AutoContactVTee}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoHorizontal}{Auto\-Horizontal} \\*Concrete Horizontal \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} }{\pageref{classKatabatic_1_1AutoHorizontal}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} \\*Abstract base class for \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} }{\pageref{classKatabatic_1_1AutoSegment}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoSegments__Aligneds}{Auto\-Segments\-\_\-\-Aligneds} \\*All aligned \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} of a set }{\pageref{classKatabatic_1_1AutoSegments__Aligneds}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoSegments__AnchorOnGCell}{Auto\-Segments\-\_\-\-Anchor\-On\-G\-Cell} \\*All \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} Beginning and/or Stopping in a \hyperlink{classKatabatic_1_1GCell}{G\-Cell} }{\pageref{classKatabatic_1_1AutoSegments__AnchorOnGCell}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoSegments__InDirection}{Auto\-Segments\-\_\-\-In\-Direction} \\*Filter to select \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} in a given direction }{\pageref{classKatabatic_1_1AutoSegments__InDirection}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoSegments__IsAccountable}{Auto\-Segments\-\_\-\-Is\-Accountable} \\*Filter to select accoutable \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} }{\pageref{classKatabatic_1_1AutoSegments__IsAccountable}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoSegments__OnContact}{Auto\-Segments\-\_\-\-On\-Contact} \\*All \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} anchored on a Contact }{\pageref{classKatabatic_1_1AutoSegments__OnContact}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoSegments__Perpandiculars}{Auto\-Segments\-\_\-\-Perpandiculars} \\*All perpandicular \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} to a set of aligneds }{\pageref{classKatabatic_1_1AutoSegments__Perpandiculars}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1AutoVertical}{Auto\-Vertical} \\*Concrete Vertical \hyperlink{classKatabatic_1_1AutoSegment}{Auto\-Segment} }{\pageref{classKatabatic_1_1AutoVertical}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Base\-Grid\-::\-Axis} \\*Graduations on a \hyperlink{classKatabatic_1_1BaseGrid}{Base\-Grid} \hyperlink{classKatabatic_1_1BaseGrid_1_1Axis}{Axis} (H or V) }{\pageref{classKatabatic_1_1BaseGrid_1_1Axis}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1BaseGrid}{Base\-Grid} \\*Abstract Base Class for Irregular \hyperlink{classKatabatic_1_1Grid}{Grid} }{\pageref{classKatabatic_1_1BaseGrid}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1BaseObserver}{Base\-Observer} \\*\hyperlink{classKatabatic_1_1Observer}{Observer} Design Pattern, \hyperlink{classKatabatic_1_1Observer}{Observer} part }{\pageref{classKatabatic_1_1BaseObserver}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1ChipTools}{Chip\-Tools} \\*Utilities for Chip Level Design }{\pageref{classKatabatic_1_1ChipTools}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1GCell_1_1CompareByDensity}{G\-Cell\-::\-Compare\-By\-Density} \\*\hyperlink{classKatabatic_1_1GCell}{G\-Cell} Density Comparison Functor }{\pageref{classKatabatic_1_1GCell_1_1CompareByDensity}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1GCell_1_1CompareByIndex}{G\-Cell\-::\-Compare\-By\-Index} \\*\hyperlink{classKatabatic_1_1GCell}{G\-Cell} Index Comparison Functor }{\pageref{classKatabatic_1_1GCell_1_1CompareByIndex}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1GCell}{G\-Cell} \\*Routing Global Cell }{\pageref{classKatabatic_1_1GCell}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1GCellDensitySet}{G\-Cell\-Density\-Set} \\*\hyperlink{classKatabatic_1_1GCell}{G\-Cell} Set, sorted by density }{\pageref{classKatabatic_1_1GCellDensitySet}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1GCellGrid}{G\-Cell\-Grid} \\*\hyperlink{classKatabatic_1_1GCell}{G\-Cell} \hyperlink{classKatabatic_1_1Grid}{Grid} }{\pageref{classKatabatic_1_1GCellGrid}}{}
\item\contentsline{section}{\hyperlink{classanonymous__namespace_02LoadGrByNet_8cpp_03_1_1GCellTopology}{G\-Cell\-Topology} \\*Build the wiring for a Net inside a G\-Cell ({\bfseries internal}) }{\pageref{classanonymous__namespace_02LoadGrByNet_8cpp_03_1_1GCellTopology}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1Grid}{Grid$<$ G\-Cell\-T $>$} \\*Template Class for Regular \hyperlink{classKatabatic_1_1Grid}{Grid} }{\pageref{classKatabatic_1_1Grid}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1KatabaticEngine}{Katabatic\-Engine} \\*The \hyperlink{namespaceKatabatic}{Katabatic} Tool }{\pageref{classKatabatic_1_1KatabaticEngine}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1GCell_1_1Key}{G\-Cell\-::\-Key} \\*\hyperlink{classKatabatic_1_1GCell}{G\-Cell} \hyperlink{classKatabatic_1_1GCell_1_1Key}{Key} -\/ Density Cache }{\pageref{classKatabatic_1_1GCell_1_1Key}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1LocatorHelper}{Locator\-Helper} \\*Locator Helper Collection's Locators }{\pageref{classKatabatic_1_1LocatorHelper}}{}
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
\item\contentsline{section}{\hyperlink{classKatabatic_1_1Observable}{Observable} \\*\hyperlink{classKatabatic_1_1Observer}{Observer} Design Pattern, Subject part }{\pageref{classKatabatic_1_1Observable}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1Observer}{Observer$<$ T $>$} \\*\hyperlink{classKatabatic_1_1Observer}{Observer} Design Pattern, \hyperlink{classKatabatic_1_1Observer}{Observer} part }{\pageref{classKatabatic_1_1Observer}}{}
\item\contentsline{section}{\hyperlink{classKatabatic_1_1Session}{Session} \\*Modification \hyperlink{classKatabatic_1_1Session}{Session} for \hyperlink{namespaceKatabatic}{Katabatic} }{\pageref{classKatabatic_1_1Session}}{}
\end{DoxyCompactList}