From 0c227de6a687030abb6833d244fc1e349d4dd79e Mon Sep 17 00:00:00 2001 From: cascade Date: Fri, 8 Apr 2005 22:09:06 +0000 Subject: [PATCH] OCC8524 Modification of cdl files in order to improve extraction of description of classes and metods --- src/WOKTools/WOKTools_DataMap.cdl | 6 +++--- src/WOKTools/WOKTools_DoubleMap.cdl | 7 +++---- src/WOKTools/WOKTools_GGraph.cdl | 10 +++++----- src/WOKTools/WOKTools_Map.cdl | 2 +- 4 files changed, 12 insertions(+), 13 deletions(-) diff --git a/src/WOKTools/WOKTools_DataMap.cdl b/src/WOKTools/WOKTools_DataMap.cdl index 49af10d..df72c22 100755 --- a/src/WOKTools/WOKTools_DataMap.cdl +++ b/src/WOKTools/WOKTools_DataMap.cdl @@ -33,7 +33,7 @@ raises class DataMapIterator inherits BasicMapIterator from WOKTools ---Purpose: Provides iteration on the content of a map. The -- iteration methods are inherited from the BasicMapIterator. - ---Warning: While using an iterator on a map if the content of + -- Warning: While using an iterator on a map if the content of -- the map is modified during the iteration the -- result is unpredictable. @@ -133,7 +133,7 @@ is Find(me; K : TheKey) returns any TheItem ---Level: Public ---Purpose: Returns the Item stored with the Key in the Map. - ---Trigger: An exception is raised when is not in the map. + -- Trigger: An exception is raised when is not in the map. raises NoSuchObject from Standard ---C++: alias operator() ---C++: return const & @@ -144,7 +144,7 @@ is ---Purpose: Returns the Item stored with the Key in the -- Map. This Item can be modified with the syntax -- aMap(K) = newItem; - ---Trigger: An exception is raised when is not in the map. + -- Trigger: An exception is raised when is not in the map. ---C++: alias operator() ---C++: return & raises NoSuchObject from Standard diff --git a/src/WOKTools/WOKTools_DoubleMap.cdl b/src/WOKTools/WOKTools_DoubleMap.cdl index b52c473..a93502b 100755 --- a/src/WOKTools/WOKTools_DoubleMap.cdl +++ b/src/WOKTools/WOKTools_DoubleMap.cdl @@ -11,8 +11,7 @@ generic class DoubleMap from WOKTools (TheKey1 as any; inherits BasicMap from WOKTools ---Purpose: The DoubleMap is used to bind pairs (Key1,Key2) - -- and retrieve them in linear time. - -- + -- and retrieve them in linear time. -- See Map from WOKTools for a discussion about the number of buckets. raises @@ -25,7 +24,7 @@ raises ---Purpose: Provides iteration on the content of a map. -- The iteration methods are inherited from the BasicMapIterator. -- - ---Warning: While using an iterator on a map if the content of + -- Warning: While using an iterator on a map if the content of -- the map is modified during the iteration the result is -- unpredictable. @@ -113,7 +112,7 @@ is Bind(me : in out; K1 : TheKey1; K2 : TheKey2) ---Level: Public ---Purpose: Adds the pair , to the map. - ---Trigger: An exception is raised if K1 or K2 are already bound. + -- Trigger: An exception is raised if K1 or K2 are already bound. raises MultiplyDefined from Standard is static; diff --git a/src/WOKTools/WOKTools_GGraph.cdl b/src/WOKTools/WOKTools_GGraph.cdl index 2bf7f05..e43916f 100755 --- a/src/WOKTools/WOKTools_GGraph.cdl +++ b/src/WOKTools/WOKTools_GGraph.cdl @@ -217,14 +217,14 @@ class GEdge raises NullObject; ---Level: Public ---Purpose: Remove a node from . - ---Warning: All successors of me are also deleted. + -- Warning: All successors of me are also deleted. DelNode(me : mutable; anItem : GraphItem) raises NullObject; ---Level: Public ---Purpose: Remove all nodes from having an item . - ---Warning: All successors of me are also deleted. + -- Warning: All successors of me are also deleted. DelEdge(me : mutable; anEdge : GEdge from WOKTools) @@ -244,7 +244,7 @@ class GEdge raises NullObject ; ---Level: Public ---Purpose: Returns a set of paths between two nodes. - ---Warning: It return a set in which all elements are displayed + -- Warning: It return a set in which all elements are displayed -- in . BestPath(me : mutable; @@ -255,7 +255,7 @@ class GEdge ---Purpose: Returns a set of the smallest paths between -- two nodes of . (if there is more than one -- path, they had the same length) - ---Warning: It return a set in which all elements are displayed + -- Warning: It return a set in which all elements are displayed -- in . Find(me : mutable; @@ -292,7 +292,7 @@ class GEdge raises NullObject; ---Level: Public ---Purpose: Returns a sequence of the heirs of aNode at - ---Warning: If is zero, returns a Sequence of all Heirs of aNode. + -- Warning: If is zero, returns a Sequence of all Heirs of aNode. Brothers(me : mutable; aNode : GNode from WOKTools) diff --git a/src/WOKTools/WOKTools_Map.cdl b/src/WOKTools/WOKTools_Map.cdl index 3c41788..8f2507f 100755 --- a/src/WOKTools/WOKTools_Map.cdl +++ b/src/WOKTools/WOKTools_Map.cdl @@ -18,7 +18,7 @@ raises ---Purpose: Provides iteration on the content of a map. The -- iteration methods are inherited from the -- BasicMapIterator. - ---Warning: While using an iterator on a map if the content of + -- Warning: While using an iterator on a map if the content of -- the map is modified during the iteration the -- result is unpredictable. -- 2.39.5