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

25 lines
4.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
\subsection{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{classKite_1_1DataNegociate}{Data\-Negociate} \\*Algorimthmic datas associated the \hyperlink{classKite_1_1TrackSegment}{Track\-Segment} }{\pageref{classKite_1_1DataNegociate}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1HorizontalTrack}{Horizontal\-Track} \\*Horizontal track managment }{\pageref{classKite_1_1HorizontalTrack}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1RoutingEvent_1_1Key}{Routing\-Event\-::\-Key} \\*\hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} cached key for maps }{\pageref{classKite_1_1RoutingEvent_1_1Key}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1KiteEngine}{Kite\-Engine} \\*The \hyperlink{namespaceKite}{Kite} Tool }{\pageref{classKite_1_1KiteEngine}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1Manipulator}{Manipulator} \\*Handle \hyperlink{classKite_1_1TrackElement}{Track\-Element} ripup \& topological modifications }{\pageref{classKite_1_1Manipulator}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1NegociateWindow}{Negociate\-Window} \\*Perform the routing, main \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} manager }{\pageref{classKite_1_1NegociateWindow}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} \\*Atomic Placement Request for a \hyperlink{classKite_1_1TrackSegment}{Track\-Segment} }{\pageref{classKite_1_1RoutingEvent}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1RoutingEventHistory}{Routing\-Event\-History} \\*History of \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} }{\pageref{classKite_1_1RoutingEventHistory}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1RoutingEventLoop}{Routing\-Event\-Loop} \\*Simple loop dectector for \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} }{\pageref{classKite_1_1RoutingEventLoop}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1RoutingEventQueue}{Routing\-Event\-Queue} \\*The priority Queue of \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} }{\pageref{classKite_1_1RoutingEventQueue}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1RoutingPlane}{Routing\-Plane} \\*Array of Tracks in one Layer }{\pageref{classKite_1_1RoutingPlane}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1SegmentAction}{Segment\-Action} \\*Store request for an event to be generated on a \hyperlink{classKite_1_1TrackElement}{Track\-Element} }{\pageref{classKite_1_1SegmentAction}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1SegmentFsm}{Segment\-Fsm} \\*Pseudo-\/decorator to process a \hyperlink{classKite_1_1RoutingEvent}{Routing\-Event} }{\pageref{classKite_1_1SegmentFsm}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1SegmentObserver}{Segment\-Observer} \\*Observer on the base Auto\-Segment }{\pageref{classKite_1_1SegmentObserver}}{}
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{classKite_1_1Session}{Session} \\*\hyperlink{namespaceKite}{Kite} update \hyperlink{classKite_1_1Session}{Session} }{\pageref{classKite_1_1Session}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1Track}{Track} \\*Structure managing one routing track }{\pageref{classKite_1_1Track}}{}
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
\item\contentsline{section}{\hyperlink{classKite_1_1TrackElement}{Track\-Element} \\*Abstract Class for all Elements inserted inside a \hyperlink{classKite_1_1Track}{Track} }{\pageref{classKite_1_1TrackElement}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1TrackFixedSegment}{Track\-Fixed\-Segment} \\*\hyperlink{classKite_1_1Track}{Track} elements for fixed wires }{\pageref{classKite_1_1TrackFixedSegment}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1TrackMarker}{Track\-Marker} \\*Tag part of \hyperlink{classKite_1_1Track}{Track} with a weight }{\pageref{classKite_1_1TrackMarker}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1TrackSegment}{Track\-Segment} \\*Derived {\bf Katabatic\-::\-Auto\-Segment} for the router }{\pageref{classKite_1_1TrackSegment}}{}
\item\contentsline{section}{\hyperlink{classKite_1_1VerticalTrack}{Vertical\-Track} \\*Vertical track managment }{\pageref{classKite_1_1VerticalTrack}}{}
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
\end{DoxyCompactList}