jcarr
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Correct some broken links.

This commit is contained in:
Jean-Paul Chaput 2008-07-25 13:29:26 +00:00
parent bc3000ecb6
commit 7857044814
4 changed files with 115 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
hurricane/doc/hurricane/Go.dox
View File

@ -126,11 +126,11 @@ CloseUpdateSession();
*/ */
// \{ // \{
/*! \function bool Go::AutoMaterializationIsDisabled(); /*! \function bool Go::autoMaterializationIsDisabled();
* No description. * No description.
*/ */
/*! \function bool Go::IsMaterialized() const; /*! \function bool Go::isMaterialized() const;
* No description. * No description.
*/ */
@ -141,11 +141,11 @@ CloseUpdateSession();
*/ */
// \{ // \{
/*! \function void Go::EnableAutoMaterialization(); /*! \function void Go::enableAutoMaterialization();
* \see Go::DisableAutoMaterialization(). * \see Go::DisableAutoMaterialization().
*/ */
/*! \function void Go::DisableAutoMaterialization(); /*! \function void Go::disableAutoMaterialization();
* Those two static member functions allows to inhibit * Those two static member functions allows to inhibit
* or restore the automatic materialization of all * or restore the automatic materialization of all
* graphic objects. * graphic objects.
@ -179,15 +179,15 @@ Cell* LoadCellFromFile(...)
\endcode \endcode
*/ */
/*! \function void Go::Materialize(); /*! \function void Go::materialize();
* No description. * No description.
*/ */
/*! \function void Go::Unmaterialize(); /*! \function void Go::unmaterialize();
* No description. * No description.
*/ */
/*! \function void Go::Invalidate(bool propagateFlag = true); /*! \function void Go::invalidate(bool propagateFlag = true);
* This method must be called before a change of the * This method must be called before a change of the
* object geometry. * object geometry.
* *
@ -271,7 +271,7 @@ void Instance::SetTransformation(const Transformation& transformation)
\endcode \endcode
*/ */
/*! \function void Go::Translate(const Unit& dx, const Unit& dy); /*! \function void Go::translate(const DbU::Unit& dx, const DbU::Unit& dy);
* Translate the graphic object of the quantity \c \<dx\> and * Translate the graphic object of the quantity \c \<dx\> and
* \c \<dy\>. * \c \<dy\>.
* *

34
hurricane/doc/hurricane/Instance.dox
View File

@ -23,7 +23,7 @@
* *
* \section secInstancePredefinedFilters Predefined filters * \section secInstancePredefinedFilters Predefined filters
* *
* <b>Hurricane::Instance::GetIsUnderFilter</b> * <b>Hurricane::Instance::getIsUnderFilter</b>
*/ */
@ -37,11 +37,11 @@
*/ */
// \{ // \{
/*! \function Instance* Instance::Create(Cell* cell, const Name& name, Cell* masterCell, bool secureFlag = true); /*! \function Instance* Instance::create(Cell* cell, const Name& name, Cell* masterCell, bool secureFlag = true);
* No description. * No description.
*/ */
/*! \function Instance* Instance::Create(Cell* cell, const Name& name, Cell* masterCell,const Transformation& transformation, const PlacementStatus& placementstatus, bool secureFlag = true); /*! \function Instance* Instance::create(Cell* cell, const Name& name, Cell* masterCell,const Transformation& transformation, const PlacementStatus& placementstatus, bool secureFlag = true);
* Create and return a pointer to a new instance of name * Create and return a pointer to a new instance of name
* \c \<name\> belonging to the cell \c \<cell\> and refering * \c \<name\> belonging to the cell \c \<cell\> and refering
* the cell \c \<masterCell\> through a transformation * the cell \c \<masterCell\> through a transformation
@ -64,24 +64,24 @@
*/ */
// \{ // \{
/*! \function const Name& Instance::GetName() const; /*! \function const Name& Instance::getName() const;
* \Return the instance name. * \Return the instance name.
*/ */
/*! \function Cell* Instance::GetMasterCell() const; /*! \function Cell* Instance::getMasterCell() const;
* \Return the cell model referenced by the instance. * \Return the cell model referenced by the instance.
*/ */
/*! \function const Transformation& Instance::GetTransformation() const; /*! \function const Transformation& Instance::getTransformation() const;
* \Return the transformation associated to the instance. * \Return the transformation associated to the instance.
*/ */
/*! \function Plug* Instance::GetPlug(const Net* masterNet) const; /*! \function Plug* Instance::getPlug(const Net* masterNet) const;
* \Return the plug associated to the \c \<masterNet\> if it exists or * \Return the plug associated to the \c \<masterNet\> if it exists or
* else NULL (if the net is not external). * else NULL (if the net is not external).
*/ */
/*! \function Plugs Instance::GetPlugs() const; /*! \function Plugs Instance::getPlugs() const;
* \Return the collection of instance plugs. * \Return the collection of instance plugs.
* *
* \important Each external net of the master cell of the instance has by * \important Each external net of the master cell of the instance has by
@ -89,20 +89,20 @@
* not to a net in the owner cell of the instance. * not to a net in the owner cell of the instance.
*/ */
/*! \function Plugs Instance::GetConnectedPlugs() const; /*! \function Plugs Instance::getConnectedPlugs() const;
* \Return the collection of instance plugs which are effectively * \Return the collection of instance plugs which are effectively
* connected. * connected.
*/ */
/*! \function Plugs Instance::GetUnconnectedPlugs() const; /*! \function Plugs Instance::getUnconnectedPlugs() const;
* \Return the collection of instance plugs which are not connected. * \Return the collection of instance plugs which are not connected.
*/ */
/*! \function Path Instance::GetPath(const Path& tailPath=Path()) const; /*! \function Path Instance::getPath(const Path& tailPath=Path()) const;
* \Return the path composed of the instance solely. * \Return the path composed of the instance solely.
*/ */
/*! \function Path Instance::GetPath(const Path& tailPath) const; /*! \function Path Instance::getPath(const Path& tailPath) const;
* \Return the path resulting of the concatenation of the instance and * \Return the path resulting of the concatenation of the instance and
* the tail path (possibly empty). * the tail path (possibly empty).
* *
@ -111,13 +111,13 @@
* the tail path is not the master cell of the instance). * the tail path is not the master cell of the instance).
*/ */
/*! \function Box Instance::GetAbutmentBox() const; /*! \function Box Instance::getAbutmentBox() const;
* \Return the abutment box of the instance, that is the abutment box of * \Return the abutment box of the instance, that is the abutment box of
* the master cell to which has been applied the instance * the master cell to which has been applied the instance
* transformation. * transformation.
*/ */
/*! \function InstanceFilter Instance::GetIsUnderFilter(const Box& area); /*! \function InstanceFilter Instance::getIsUnderFilter(const Box& area);
* \Return the filter selecting instances which intersect the given * \Return the filter selecting instances which intersect the given
* area. * area.
*/ */
@ -129,18 +129,18 @@
*/ */
// \{ // \{
/*! \function void Instance::SetName(const Name& name); /*! \function void Instance::setName(const Name& name);
* Allows to change the instance name. * Allows to change the instance name.
* *
* \remark Throws an exception if the name is empty or if an instance * \remark Throws an exception if the name is empty or if an instance
* with the same name exists in the owner cell. * with the same name exists in the owner cell.
*/ */
/*! \function void Instance::SetTransformation(const Transformation& transformation); /*! \function void Instance::setTransformation(const Transformation& transformation);
* Allows to modify the instance transformation. * Allows to modify the instance transformation.
*/ */
/*! \function void Instance::SetMasterCell(Cell* masterCell, bool secureFlag = true); /*! \function void Instance::setMasterCell(Cell* masterCell, bool secureFlag = true);
* Allows to change the cell referenced by this instance. * Allows to change the cell referenced by this instance.
* *
* \caution Throws an exception if either the cell is null, a cyclic * \caution Throws an exception if either the cell is null, a cyclic

143
hurricane/doc/hurricane/Net.dox
View File

@ -9,11 +9,11 @@
* *
* \section secNetPredefinedFilters Predefined filters * \section secNetPredefinedFilters Predefined filters
* *
* <b>Hurricane::Net::GetIsGlobalFilter</b> * <b>Hurricane::Net::getIsGlobalFilter</b>
* <b>Hurricane::Net::GetIsExternalFilter</b> * <b>Hurricane::Net::getIsExternalFilter</b>
* <b>Hurricane::Net::GetIsInternalFilter</b> * <b>Hurricane::Net::getIsInternalFilter</b>
* <b>Hurricane::Net::GetIsClockFilter</b> * <b>Hurricane::Net::getIsClockFilter</b>
* <b>Hurricane::Net::GetIsSupplyFilter</b> * <b>Hurricane::Net::getIsSupplyFilter</b>
*/ */
@ -28,29 +28,60 @@
*/ */
/*! \class Net::Type /*! \class Net::Type
* This enumeration defines the signal category. table: * Encapsulate the Net::Type::Code enumeration that defines the
* Available Signal Types headers: Name Code Signification * signal category.
* slots: UNDEFINED 0 Type undefined slots: LOGICAL 1 Type */
* assigned to ordinary signals slots: CLOCK 2 Type assigned to
* clock signals slots: SUPPLY 3 Type assigned to supply signals /*! \enum Net::Type::Code
* This enumeration defines the signal category inside the Net::Type.
*/
/*! \var Net::Type::Code Net::Type::UNDEFINED
* Type undefined.
*/
/*! \var Net::Type::Code Net::Type::LOGICAL
* Type assigned to ordinary signals.
*/
/*! \var Net::Type::Code Net::Type::CLOCK
* Type assigned to clock signals.
*/
/*! \var Net::Type::Code Net::Type::POWER
* Type assigned to supply signals.
*/
/*! \var Net::Type::Code Net::Type::GROUND
* Type assigned to supply signals.
*/ */
/*! \class Net::Direction /*! \class Net::Direction
* This enumeration defines the signal direction. This direction * Encapsulate the Net::Direction::Code enumeration that defines the
* is meaningful for external nets only. table: Available * signal direction. This direction is meaningful for external nets only.
* Directions headers: Name Code Signification slots: UNDEFINED */
* 0 Undefined direction slots: IN 1 There must be no driver
* inside and a single permanent driver outside slots: OUT 2 /*! \enum Net::Direction::Code
* This enumeration defines the signal direction inside the Net::Direction.
*/
/*! \var Net::Direction::Code Net::Direction::UNDEFINED
* Undefined direction.
*/
/*! \var Net::Direction::Code Net::Direction::IN
* There must be no driver inside and a single permanent driver
* outside.
*/
/*! \var Net::Direction::Code Net::Direction::OUT
* There must be no driver outside and a single permanent driver * There must be no driver outside and a single permanent driver
* inside slots: INOUT 3 No constraint slots: TRISTATE 4 Type * inside.
* assigned to logical tri-states signals */
/*! \var Net::Direction::Code Net::Direction::INOUT
* No constraint.
*/
/*! \var Net::Direction::Code Net::Direction::TRISTATE
* Type assigned to logical tri-states signals.
*/ */
/*! \name Constructors /*! \name Constructors
*/ */
// \{ // \{
/*! \function Net* Net::Create(Cell* cell, const Name& name); /*! \function Net* Net::create(Cell* cell, const Name& name);
* Creates and returns a new net named \c \<name\> for the cell * Creates and returns a new net named \c \<name\> for the cell
* \c \<cell\>. * \c \<cell\>.
* *
@ -65,84 +96,84 @@
*/ */
// \{ // \{
/*! \function const Name& Net::GetName() const; /*! \function const Name& Net::getName() const;
* \Return the net name. * \Return the net name.
*/ */
/*! \function const Net::Arity& Net::GetArity() const; /*! \function const Net::Arity& Net::getArity() const;
* \Return the signal arity (by default set to 1). * \Return the signal arity (by default set to 1).
*/ */
/*! \function const Net::Type& Net::GetType() const; /*! \function const Net::Type& Net::getType() const;
* \Return the signal type (by default set to UNDEFINED). * \Return the signal type (by default set to UNDEFINED).
*/ */
/*! \function const Net::Direction& Net::GetDirection() const; /*! \function const Net::Direction& Net::getDirection() const;
* \Return the signal direction (by default set to UNDEFINED). * \Return the signal direction (by default set to UNDEFINED).
* *
* \remark This direction is meaningfull only for external nets. * \remark This direction is meaningfull only for external nets.
*/ */
/*! \function const Point& Net::GetPosition() const; /*! \function const Point& Net::getPosition() const;
* \Return the X,Y position of the net. This position is used for * \Return the X,Y position of the net. This position is used for
* computing the location of the plugs (on slave instances * computing the location of the plugs (on slave instances
* calling the cell owning this net) having that net as master. * calling the cell owning this net) having that net as master.
*/ */
/*! \function const Unit& Net::GetX() const; /*! \function const Unit& Net::getX() const;
* \Return net abscissa. * \Return net abscissa.
*/ */
/*! \function const Unit& Net::GetY() const; /*! \function const Unit& Net::getY() const;
* \Return net ordinate. * \Return net ordinate.
*/ */
/*! \function Rubbers Net::GetRubbers() const; /*! \function Rubbers Net::getRubbers() const;
* \Return the collection of net's rubbers. * \Return the collection of net's rubbers.
*/ */
/*! \function Components Net::GetComponents() const; /*! \function Components Net::getComponents() const;
* \Return the collection of net's components. * \Return the collection of net's components.
*/ */
/*! \function Plugs Net::GetPlugs() const; /*! \function Plugs Net::getPlugs() const;
* \Return the collection of net's plugs. * \Return the collection of net's plugs.
*/ */
/*! \function Contacts Net::GetContacts() const; /*! \function Contacts Net::getContacts() const;
* \Return the collection of net's contacts. * \Return the collection of net's contacts.
*/ */
/*! \function Segments Net::GetSegments() const; /*! \function Segments Net::getSegments() const;
* \Return the collection of net's segments. * \Return the collection of net's segments.
*/ */
/*! \function Verticals Net::GetVerticals() const; /*! \function Verticals Net::getVerticals() const;
* \Return the collection of net's vertical segments. * \Return the collection of net's vertical segments.
*/ */
/*! \function Horizontals Net::GetHorizontals() const; /*! \function Horizontals Net::getHorizontals() const;
* \Return the collection of net's horizontal segments. * \Return the collection of net's horizontal segments.
*/ */
/*! \function Pads Net::GetPads() const; /*! \function Pads Net::getPads() const;
* \Return the collection of net's pads. * \Return the collection of net's pads.
*/ */
/*! \function Plugs Net::GetSlavePlugs() const; /*! \function Plugs Net::getSlavePlugs() const;
* \Return the collection of plugs which have this net as master. * \Return the collection of plugs which have this net as master.
* *
* \remark Meaningfull only for external nets. * \remark Meaningfull only for external nets.
*/ */
/*! \function Plugs Net::GetConnectedSlavePlugs() const; /*! \function Plugs Net::getConnectedSlavePlugs() const;
* \Return the collection of connected plugs which have this net as * \Return the collection of connected plugs which have this net as
* master. * master.
* *
* \remark Meaningfull only for external nets. * \remark Meaningfull only for external nets.
*/ */
/*! \function Plugs Net::GetUnconnectedSlavePlugs() const; /*! \function Plugs Net::getUnconnectedSlavePlugs() const;
* \Return the collection of unconnected plugs which have this net as * \Return the collection of unconnected plugs which have this net as
* master. * master.
* *
@ -156,15 +187,15 @@
*/ */
// \{ // \{
/*! \function bool Net::IsGlobal() const; /*! \function bool Net::isGlobal() const;
* \Return \true if the net is global else \false. * \Return \true if the net is global else \false.
*/ */
/*! \function bool Net::IsExternal() const; /*! \function bool Net::isExternal() const;
* \Return \true if the net is external else \false. * \Return \true if the net is external else \false.
*/ */
/*! \function bool Net::IsLogical() const; /*! \function bool Net::isLogical() const;
* \Return \true if the net is logical else \false. * \Return \true if the net is logical else \false.
*/ */
@ -172,11 +203,11 @@
* \Return \true if the net is tri-state else \false. * \Return \true if the net is tri-state else \false.
*/ */
/*! \function bool Net::IsClock() const; /*! \function bool Net::isClock() const;
* \Return \true if the net is a clock else \false. * \Return \true if the net is a clock else \false.
*/ */
/*! \function bool Net::IsSupply() const; /*! \function bool Net::isSupply() const;
* \Return \true if the net is a supply else \false. * \Return \true if the net is a supply else \false.
*/ */
@ -187,50 +218,50 @@
*/ */
// \{ // \{
/*! \function void Net::SetName(const Name& name); /*! \function void Net::setName(const Name& name);
* Allows to change net name. * Allows to change net name.
* *
* \remark Throws an exception if the new name is empty, or if a net * \remark Throws an exception if the new name is empty, or if a net
* with same net already exists in the cell. * with same net already exists in the cell.
*/ */
/*! \function void Net::SetArity(const Net::Arity& arity); /*! \function void Net::setArity(const Net::Arity& arity);
* Sets the signal arity to \c \<arity\>. * Sets the signal arity to \c \<arity\>.
*/ */
/*! \function void Net::SetGlobal(bool state); /*! \function void Net::setGlobal(bool state);
* Sets global signal status to \c \<state\>. * Sets global signal status to \c \<state\>.
*/ */
/*! \function void Net::SetExternal(bool state); /*! \function void Net::setExternal(bool state);
* Sets the external net status to \c \<state\>. * Sets the external net status to \c \<state\>.
* *
* \remark This function will throw an exception if the net switches to * \remark This function will throw an exception if the net switches to
* internal and there is a plug refering to it. * internal and there is a plug refering to it.
*/ */
/*! \function void Net::SetType(const Net::Type& type); /*! \function void Net::setType(const Net::Type& type);
* Sets the signal type of the net. * Sets the signal type of the net.
*/ */
/*! \function void Net::SetDirection(const Net::Direction& direction); /*! \function void Net::setDirection(const Net::Direction& direction);
* Sets the signal direction of the net. * Sets the signal direction of the net.
*/ */
/*! \function void Net::SetPosition(const Point& position); /*! \function void Net::setPosition(const Point& position);
* Sets the X,Y location of the net. By default it is located at * Sets the X,Y location of the net. By default it is located at
* the coordinates origin of the cell (point 0,0). * the coordinates origin of the cell (point 0,0).
*/ */
/*! \function void Net::Materialize();; /*! \function void Net::materialize();;
* Materializes all the rubbers and components of a net. * Materializes all the rubbers and components of a net.
*/ */
/*! \function void Net::Unmaterialize();; /*! \function void Net::unmaterialize();;
* De-materializes all rubbers and the components of a net. * De-materializes all rubbers and the components of a net.
*/ */
/*! \function void Net::Merge(Net* net); /*! \function void Net::merge(Net* net);
* Merges the net \c \<net\> to the net \c \<this\> which keeps * Merges the net \c \<net\> to the net \c \<this\> which keeps
* its characteristics (arity, global, external and direction). * its characteristics (arity, global, external and direction).
* *
@ -285,23 +316,23 @@
*/ */
// \{ // \{
/*! \function NetFilter Net::GetIsGlobalFilter(); /*! \function NetFilter Net::getIsGlobalFilter();
* \Return the filter selecting global nets. * \Return the filter selecting global nets.
*/ */
/*! \function NetFilter Net::GetIsExternalFilter(); /*! \function NetFilter Net::getIsExternalFilter();
* \Return the filter selecting external nets. * \Return the filter selecting external nets.
*/ */
/*! \function NetFilter Net::GetIsInternalFilter(); /*! \function NetFilter Net::getIsInternalFilter();
* \Return the filter selecting internal nets. * \Return the filter selecting internal nets.
*/ */
/*! \function NetFilter Net::GetIsClockFilter(); /*! \function NetFilter Net::getIsClockFilter();
* \Return the filter selecting clock nets. * \Return the filter selecting clock nets.
*/ */
/*! \function NetFilter Net::GetIsSupplyFilter(); /*! \function NetFilter Net::getIsSupplyFilter();
* \Return the filter selecting supply nets. * \Return the filter selecting supply nets.
*/ */

6
hurricane/doc/hurricane/doxyfile
View File

@ -161,13 +161,13 @@ INPUT = \
Cell.dox \ Cell.dox \
../../src/hurricane/hurricane/Nets.h \ ../../src/hurricane/hurricane/Nets.h \
../../src/hurricane/hurricane/Net.h \ ../../src/hurricane/hurricane/Net.h \
Cell.dox \ Net.dox \
../../src/hurricane/hurricane/Gos.h \ ../../src/hurricane/hurricane/Gos.h \
../../src/hurricane/hurricane/Go.h \ ../../src/hurricane/hurricane/Go.h \
Cell.dox \ Go.dox \
../../src/hurricane/hurricane/Instances.h \ ../../src/hurricane/hurricane/Instances.h \
../../src/hurricane/hurricane/Instance.h \ ../../src/hurricane/hurricane/Instance.h \
Cell.dox \ Instance.dox \
../../src/hurricane/hurricane/Components.h \ ../../src/hurricane/hurricane/Components.h \
../../src/hurricane/hurricane/Component.h \ ../../src/hurricane/hurricane/Component.h \
Component.dox \ Component.dox \