diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 21:47:17 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:00:59 +0200 |
| commit | 944eb9902788d8afec9e3f0f65d3b680041e039b (patch) | |
| tree | 3bbb926890561b81d9f6ae611be4677876799a36 /offapi/com/sun/star/drawing | |
| parent | cdbbbdce9956e290b4a849af332df55da1be8d36 (diff) | |
*api: convert <type>Foo</type>
Doxygen does not know type element and will recognize strings that
contain capital letter (all API types do) automatically as type.
This patch removes 15k doxygen warnings.
git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1,"
Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
Diffstat (limited to 'offapi/com/sun/star/drawing')
100 files changed, 361 insertions, 361 deletions
diff --git a/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl b/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl index 4a7579408a96..001a3bae76ea 100644 --- a/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl +++ b/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleDrawDocumentView</type> service is implemented by +/** The AccessibleDrawDocumentView service is implemented by views of Draw and Impress documents. - <p>An object that implements the <type>AccessibleDrawDocumentView</type> + <p>An object that implements the AccessibleDrawDocumentView service provides information about the view of a Draw or Impress document in one of the various view modes. With its children it gives access to the current page and the shapes on that page.</p> @@ -115,7 +115,7 @@ service AccessibleDrawDocumentView of the currently visible area and to let the user find children (i.e. shapes) that cover a given test point. The more interesting part of the graphical representation of a draw page lies in its - children. See the <type>AccessibleShape</type> service for more + children. See the AccessibleShape service for more information about shapes.</p> @see AccessibleShape diff --git a/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl b/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl index 6a92e1610569..9fe1021ffb3e 100644 --- a/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl +++ b/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleGraphicShape</type> service is implemented by the +/** The AccessibleGraphicShape service is implemented by the graphic object shapes shapes com.sun.star.drawing.GraphicObjectShape and com.sun.star.presentation.GraphicObjectShape. - <p>It differs from the included <type>AccessibleShape</type> "base" + <p>It differs from the included AccessibleShape "base" service by the additional support of the <type scope="::com::sun::star::accessibility">XAccessibleImage</type> @@ -41,7 +41,7 @@ service AccessibleGraphicShape { /** Give access to information of generic shapes. - <p>See <type>AccessibleShape</type> for documentation and support of + <p>See AccessibleShape for documentation and support of the interfaces <type scope="::com::sun::star::accessibility">XAccessible</type>, <type scope="::com::sun::star::accessibility">XAccessibleContext</type>, @@ -60,7 +60,7 @@ service AccessibleGraphicShape requires the shape to provide a description of the displayed image and the image's size in the screen coordinate system (pixel). At the time being this interface does not provide information that is - not available through the <type>AccessibleShape</type> service: + not available through the AccessibleShape service: the size returned by the <member scope="::com::sun::star::accessibility" >XAccessibleImage::getWidth</member> and <member diff --git a/offapi/com/sun/star/drawing/AccessibleOLEShape.idl b/offapi/com/sun/star/drawing/AccessibleOLEShape.idl index f24e51ff0516..5a202670b383 100644 --- a/offapi/com/sun/star/drawing/AccessibleOLEShape.idl +++ b/offapi/com/sun/star/drawing/AccessibleOLEShape.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleOLEShape</type> service is implemented by +/** The AccessibleOLEShape service is implemented by OLE shapes. <p>This includes generic OLE shapes, frames, plug-ins, and applets.</p> @@ -50,7 +50,7 @@ service AccessibleOLEShape { /** Give access to information of generic shapes. - <p>See <type>AccessibleShape</type> for basic documentation and + <p>See AccessibleShape for basic documentation and support of the <type scope="::com::sun::star::accessibility" >XAccessibleContext</type>, and diff --git a/offapi/com/sun/star/drawing/AccessibleShape.idl b/offapi/com/sun/star/drawing/AccessibleShape.idl index 122bd44e2b57..e19e93d820d7 100644 --- a/offapi/com/sun/star/drawing/AccessibleShape.idl +++ b/offapi/com/sun/star/drawing/AccessibleShape.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleShape</type> service is implemented by UNO shapes to +/** The AccessibleShape service is implemented by UNO shapes to provide accessibility information that describe the shape's features. A UNO shape is any object that implements the <type scope="::com::sun::star::drawing">XShape</type> interface. @@ -35,14 +35,14 @@ module com { module sun { module star { module drawing { and accessible text paragraphs. The root of this (sub-)tree is the accessible draw document view. An accessible shape implements either this service or one of the "derived" services - <type>AccessibleGraphicShape</type> or <type>AccessibleOLEShape</type>. + AccessibleGraphicShape or AccessibleOLEShape. See the section Children in the description of the <type scope="::com::sun::star::accessibility" >XAccessibleContext</type> interface support for more details.</p> <p>There are two services that extend this one: the - <type>AccessibleGraphicShape</type> and the - <type>AccessibleOLEShape</type> services provide additional interfaces. + AccessibleGraphicShape and the + AccessibleOLEShape services provide additional interfaces. See there for details.</p> <p>A shape object is either fully or partially visible on the screen or @@ -84,7 +84,7 @@ service AccessibleShape >AccessibleParagraphView</type> for details of how this text is represented.</li> <li>Parent: The parent is either the document view as represented by - <type>AccessibleDrawDocumentView</type> or a group shape, 3D + AccessibleDrawDocumentView or a group shape, 3D scene shape, or OLE shape.</li> <li>Relations: Are set and maintained from the outside. See the service description of the object that has accessible shapes as diff --git a/offapi/com/sun/star/drawing/AccessibleSlideView.idl b/offapi/com/sun/star/drawing/AccessibleSlideView.idl index 6ff48387d7a6..a5b248d214c6 100644 --- a/offapi/com/sun/star/drawing/AccessibleSlideView.idl +++ b/offapi/com/sun/star/drawing/AccessibleSlideView.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleSlideView</type> service is implemented by +/** The AccessibleSlideView service is implemented by slide views of Impress documents. <p>An accessible slide view gives access to all visible slides of a diff --git a/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl b/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl index 952a30c56fbc..3adaba8e7bb7 100644 --- a/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl +++ b/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleSlideViewObject</type> service is implemented by +/** The AccessibleSlideViewObject service is implemented by the slides of the slide view of Impress documents. <p>An accessible slide view object gives access to one of the visible diff --git a/offapi/com/sun/star/drawing/Alignment.idl b/offapi/com/sun/star/drawing/Alignment.idl index 4c9819f3fab4..4150f517d50a 100644 --- a/offapi/com/sun/star/drawing/Alignment.idl +++ b/offapi/com/sun/star/drawing/Alignment.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>Alignment</type> enumeration is a general way to specify the +/** The Alignment enumeration is a general way to specify the alignment of an object or sub-object relative to another object. */ published enum Alignment diff --git a/offapi/com/sun/star/drawing/AppletShape.idl b/offapi/com/sun/star/drawing/AppletShape.idl index 71c3d8833c20..baa256adbd82 100644 --- a/offapi/com/sun/star/drawing/AppletShape.idl +++ b/offapi/com/sun/star/drawing/AppletShape.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** This <type>Shape</type> encapsulates an applet. +/** This Shape encapsulates an applet. <p> An applet is a small Java-based program that is executed and rendered embedded in a document. @@ -34,7 +34,7 @@ published service AppletShape { /** basic service for position, size and z-order. - <p>A <type>AppletShape</type> cannot be rotated. + <p>A AppletShape cannot be rotated. */ service com::sun::star::drawing::Shape; diff --git a/offapi/com/sun/star/drawing/BitmapMode.idl b/offapi/com/sun/star/drawing/BitmapMode.idl index 9a4172ae24f3..0172bc2b89e0 100644 --- a/offapi/com/sun/star/drawing/BitmapMode.idl +++ b/offapi/com/sun/star/drawing/BitmapMode.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { -/** The <type>BitmapMode</type> selects an algorithm for filling an area with +/** The BitmapMode selects an algorithm for filling an area with a bitmap. */ published enum BitmapMode diff --git a/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl b/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl index 30dd4133ba98..ff9fd4e5c9b3 100644 --- a/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl +++ b/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { /** this flags describe escape direction for - the line of a <type>CaptionShape</type>. + the line of a CaptionShape. @see CaptionShape */ diff --git a/offapi/com/sun/star/drawing/CaptionShape.idl b/offapi/com/sun/star/drawing/CaptionShape.idl index 38817aa56143..1b0998d0e92a 100644 --- a/offapi/com/sun/star/drawing/CaptionShape.idl +++ b/offapi/com/sun/star/drawing/CaptionShape.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module drawing { -/** The <type>CaptionShape</type> represents a rectangular drawing shape +/** The CaptionShape represents a rectangular drawing shape with an additional set of lines. It can be used as a description for a fixed point inside a drawing. */ diff --git a/offapi/com/sun/star/drawing/CaptionType.idl b/offapi/com/sun/star/drawing/CaptionType.idl index 99d92425c412..5a881b4a36f0 100644 --- a/offapi/com/sun/star/drawing/CaptionType.idl +++ b/offapi/com/sun/star/drawing/CaptionType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** This constants specifies the geometry of the line of a <type>CaptionShape</type>. +/** This constants specifies the geometry of the line of a CaptionShape. @see CaptionShape */ diff --git a/offapi/com/sun/star/drawing/ColorMode.idl b/offapi/com/sun/star/drawing/ColorMode.idl index df688b62636d..90288b6b4b77 100644 --- a/offapi/com/sun/star/drawing/ColorMode.idl +++ b/offapi/com/sun/star/drawing/ColorMode.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>ColorMode</type> defines the output style of colors +/** The ColorMode defines the output style of colors for a graphic. */ published enum ColorMode diff --git a/offapi/com/sun/star/drawing/ConnectorShape.idl b/offapi/com/sun/star/drawing/ConnectorShape.idl index fd3f8302daae..61112ffe8701 100644 --- a/offapi/com/sun/star/drawing/ConnectorShape.idl +++ b/offapi/com/sun/star/drawing/ConnectorShape.idl @@ -37,8 +37,8 @@ module com { module sun { module star { module drawing { -/** This service is for a <type>ConnectorShape</type>, a specialized <type>Shape</type>, - which can be connected to other <type>Shape</type>s or <type>GluePoint</type>s. +/** This service is for a ConnectorShape, a specialized Shape, + which can be connected to other Shapes or GluePoints. */ published service ConnectorShape { diff --git a/offapi/com/sun/star/drawing/ConnectorType.idl b/offapi/com/sun/star/drawing/ConnectorType.idl index 1d4d704d9dd4..c693ad22d014 100644 --- a/offapi/com/sun/star/drawing/ConnectorType.idl +++ b/offapi/com/sun/star/drawing/ConnectorType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>ConnectorType</type> specifies the appearance of a connector. +/** The ConnectorType specifies the appearance of a connector. */ published enum ConnectorType { diff --git a/offapi/com/sun/star/drawing/ControlShape.idl b/offapi/com/sun/star/drawing/ControlShape.idl index 39df9249294a..4ecb5f3d62ec 100644 --- a/offapi/com/sun/star/drawing/ControlShape.idl +++ b/offapi/com/sun/star/drawing/ControlShape.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** This service is for a <type>Shape</type> which contains a control. +/** This service is for a Shape which contains a control. <p> @see Shape @see XControlShape diff --git a/offapi/com/sun/star/drawing/DashTable.idl b/offapi/com/sun/star/drawing/DashTable.idl index 76f90d08b005..2e140c42bb46 100644 --- a/offapi/com/sun/star/drawing/DashTable.idl +++ b/offapi/com/sun/star/drawing/DashTable.idl @@ -25,9 +25,9 @@ module com { module sun { module star { module drawing { -/** this is a container for <type>LineDash</type>s +/** this is a container for LineDashs - <p>It is used for example to access the <type>LineDash</type>s that + <p>It is used for example to access the LineDashs that are used inside a document. @see DrawingDocumentFactory @@ -35,7 +35,7 @@ */ published service DashTable { - /** this container lets you access the <type>LineDash</type>s that + /** this container lets you access the LineDashs that are indexed with a name. <p>Note: You can add new entries for later use, but you cannot diff --git a/offapi/com/sun/star/drawing/DrawPage.idl b/offapi/com/sun/star/drawing/DrawPage.idl index bba8b71a115f..50d3b153e154 100644 --- a/offapi/com/sun/star/drawing/DrawPage.idl +++ b/offapi/com/sun/star/drawing/DrawPage.idl @@ -41,7 +41,7 @@ published service DrawPage */ service com::sun::star::drawing::GenericDrawPage; - /** provides the link to a <type>MasterPage</type>. + /** provides the link to a MasterPage. */ interface com::sun::star::drawing::XMasterPageTarget; diff --git a/offapi/com/sun/star/drawing/DrawPages.idl b/offapi/com/sun/star/drawing/DrawPages.idl index ede769622917..17b9587e8721 100644 --- a/offapi/com/sun/star/drawing/DrawPages.idl +++ b/offapi/com/sun/star/drawing/DrawPages.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module drawing { -/** provides access to a container of <type>DrawPage</type>s +/** provides access to a container of DrawPages and makes it possible for you to manipulate them. @see XDrawPagesSupplier @@ -37,7 +37,7 @@ */ published service DrawPages { - /** lets you access and create <type>DrawPage</type>s + /** lets you access and create DrawPages */ interface com::sun::star::drawing::XDrawPages; diff --git a/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl b/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl index 198c813c86ac..674ac7ed3d66 100644 --- a/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl +++ b/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl @@ -39,8 +39,8 @@ module com { module sun { module star { module view { module com { module sun { module star { module drawing { -/** This component integrates a view to a <type>DrawPage</type>s or - <type>MasterPage</type> from a <type>DrawingDocument</type>. +/** This component integrates a view to a DrawPages or + MasterPage from a DrawingDocument. */ published service DrawingDocumentDrawView { diff --git a/offapi/com/sun/star/drawing/GenericDrawPage.idl b/offapi/com/sun/star/drawing/GenericDrawPage.idl index dab995e29e34..8183cff457ec 100644 --- a/offapi/com/sun/star/drawing/GenericDrawPage.idl +++ b/offapi/com/sun/star/drawing/GenericDrawPage.idl @@ -39,11 +39,11 @@ module com { module sun { module star { module drawing { /** This abstract service is implemented by every page of a - <type>DrawingDocument</type>. + DrawingDocument. - @example create and insert a couple of <type>LineShape</type>s: + @example create and insert a couple of LineShapes: <listing> xPage = xDoc.DrawPages(0) @@ -60,28 +60,28 @@ published service GenericDrawPage { - /** manages the <type>Shape</type>s of this page. + /** manages the Shapes of this page. - <p>It also lets you add new <type>Shape</type>s. The program currently - requires that these <type>Shape</type>s be created by the factory of + <p>It also lets you add new Shapes. The program currently + requires that these Shapes be created by the factory of the document. - @see <type>DrawingDocument</type> + @see DrawingDocument */ interface com::sun::star::drawing::XShapes; /** With this interface you can group/ungroup a collection of - <type>Shape</type>s. + Shapes. */ interface com::sun::star::drawing::XShapeGrouper; /** With this interface you can combine/split a collection of - <type>Shape</type>s. + Shapes. */ [optional] interface com::sun::star::drawing::XShapeCombiner; /** With this interface you can bind/unbind a collection of - <type>Shape</type>s. + Shapes. */ [optional] interface com::sun::star::drawing::XShapeBinder; @@ -92,7 +92,7 @@ published service GenericDrawPage [optional] interface com::sun::star::container::XNamed; /** gives you access to the properties of this - <type>DrawPage</type>. + DrawPage. */ [optional] interface com::sun::star::beans::XPropertySet; diff --git a/offapi/com/sun/star/drawing/GenericDrawingDocument.idl b/offapi/com/sun/star/drawing/GenericDrawingDocument.idl index 61773c52bdd2..46d27fd57875 100644 --- a/offapi/com/sun/star/drawing/GenericDrawingDocument.idl +++ b/offapi/com/sun/star/drawing/GenericDrawingDocument.idl @@ -48,30 +48,30 @@ service GenericDrawingDocument /** this factory lets you create various services that are used inside a drawing document - <p>The following services are <type>Shape</type>s. + <p>The following services are Shapes. They are created by the documents factory and must - be inserted into a <type>DrawPage</type> or <type>MasterPage</type> + be inserted into a DrawPage or MasterPage of this document. <ul> - <li><type>RectangleShape</type></li> - <li><type>EllipseShape</type></li> - <li><type>ControlShape</type></li> - <li><type>ConnectorShape</type></li> - <li><type>MeasureShape</type></li> - <li><type>LineShape</type></li> - <li><type>PolyPolygonShape</type></li> - <li><type>PolyLineShape</type></li> - <li><type>OpenBezierShape</type></li> - <li><type>ClosedBezierShape</type></li> - <li><type>GraphicObjectShape</type></li> - <li><type>GroupShape</type></li> - <li><type>TextShape</type></li> - <li><type>OLE2Shape</type></li> - <li><type>PageShape</type></li> - <li><type>CaptionShape</type></li> - <li><type>PluginShape</type></li> - <li><type>AppletShape</type></li> + <li>RectangleShape</li> + <li>EllipseShape</li> + <li>ControlShape</li> + <li>ConnectorShape</li> + <li>MeasureShape</li> + <li>LineShape</li> + <li>PolyPolygonShape</li> + <li>PolyLineShape</li> + <li>OpenBezierShape</li> + <li>ClosedBezierShape</li> + <li>GraphicObjectShape</li> + <li>GroupShape</li> + <li>TextShape</li> + <li>OLE2Shape</li> + <li>PageShape</li> + <li>CaptionShape</li> + <li>PluginShape</li> + <li>AppletShape</li> </ul> <p>The following services are all <type scope="com::sun::star::text">TextField</type> @@ -112,7 +112,7 @@ service GenericDrawingDocument inside the document. <br>A <type scope="com::sun::star::image">ImageMap</type> can be obtained from a - <type>GraphicObjectShape</type> + GraphicObjectShape <ul> <li><type scope="com::sun::star::image">ImageMapRectangleObject</type></li> @@ -139,22 +139,22 @@ service GenericDrawingDocument /** provides an object that is implementing the service - <type>DrawPage</type>s. With this service you have access to the - <type>DrawPage</type>s inside a document. + DrawPages. With this service you have access to the + DrawPages inside a document. */ interface com::sun::star::drawing::XDrawPagesSupplier; /** returns an object that is implementing the service - <type>MasterPages</type>. With this service you have access to the - <type>MasterPage</type>s inside a document. + MasterPages. With this service you have access to the + MasterPages inside a document. */ interface com::sun::star::drawing::XMasterPagesSupplier; /** returns an object that is implementing the service - <type>LayerManager</type>. This service lets you manipulate the - <type>Layer</type>s of this document. + LayerManager. This service lets you manipulate the + Layers of this document. */ interface com::sun::star::drawing::XLayerSupplier; diff --git a/offapi/com/sun/star/drawing/GluePoint.idl b/offapi/com/sun/star/drawing/GluePoint.idl index 7f1d486e4d1c..d5931f68ede1 100644 --- a/offapi/com/sun/star/drawing/GluePoint.idl +++ b/offapi/com/sun/star/drawing/GluePoint.idl @@ -25,29 +25,29 @@ module com { module sun { module star { module drawing { -/** A <type>GluePoint</type> could be attached to a shape or to a page. +/** A GluePoint could be attached to a shape or to a page. - <p>If a <type>GluePoint</type> is attached to a shape, it is moved when + <p>If a GluePoint is attached to a shape, it is moved when the shape moves. - The ends of connectors can be attached to <type>GluePoint</type>.</p> + The ends of connectors can be attached to GluePoint.</p> @deprecated @see GluePoint2 */ published struct GluePoint { - /** This is the position of this <type>GluePoint</type>. + /** This is the position of this GluePoint. */ com::sun::star::awt::Point Position; /** This is the direction in which the connector line leaves the - <type>GluePoint</type>. + GluePoint. */ short EscapeDirection; - /** If this is <TRUE/>, then the position of this <type>GluePoint</type> is + /** If this is <TRUE/>, then the position of this GluePoint is absolute on a page and is not relative to a shape. */ boolean PositionAbsolute; diff --git a/offapi/com/sun/star/drawing/GraphicExportFilter.idl b/offapi/com/sun/star/drawing/GraphicExportFilter.idl index 947260348130..190f189d29fe 100644 --- a/offapi/com/sun/star/drawing/GraphicExportFilter.idl +++ b/offapi/com/sun/star/drawing/GraphicExportFilter.idl @@ -26,7 +26,7 @@ /** a component that supports this service lets you export pages, shapes, or - groups of shapes from a <type>DrawingDocument</type> to a file in one of the + groups of shapes from a DrawingDocument to a file in one of the file formats supported by the component. */ published service GraphicExportFilter : XGraphicExportFilter; diff --git a/offapi/com/sun/star/drawing/GroupShape.idl b/offapi/com/sun/star/drawing/GroupShape.idl index 93937bf0d3ce..96a0ded1bfac 100644 --- a/offapi/com/sun/star/drawing/GroupShape.idl +++ b/offapi/com/sun/star/drawing/GroupShape.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module drawing { -/** This service is for a group of <type>Shape</type>s. +/** This service is for a group of Shapes. @see XShapeGroup @see XShapes */ @@ -45,7 +45,7 @@ published service GroupShape interface com::sun::star::drawing::XShapeGroup; - /** lets you access the <type>Shape</type>s in this Group. + /** lets you access the Shapes in this Group. */ interface com::sun::star::drawing::XShapes; diff --git a/offapi/com/sun/star/drawing/Hatch.idl b/offapi/com/sun/star/drawing/Hatch.idl index 2bada9607bf5..99c1da0b029f 100644 --- a/offapi/com/sun/star/drawing/Hatch.idl +++ b/offapi/com/sun/star/drawing/Hatch.idl @@ -33,7 +33,7 @@ */ published struct Hatch { - /** The <type>HatchStyle</type> defines the kind of lines used to draw + /** The HatchStyle defines the kind of lines used to draw this hatch. */ com::sun::star::drawing::HatchStyle Style; diff --git a/offapi/com/sun/star/drawing/HatchStyle.idl b/offapi/com/sun/star/drawing/HatchStyle.idl index b274880a65f1..e254379905f8 100644 --- a/offapi/com/sun/star/drawing/HatchStyle.idl +++ b/offapi/com/sun/star/drawing/HatchStyle.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>HatchStyle</type> defines the style of the lines in a hatch. +/** The HatchStyle defines the style of the lines in a hatch. */ published enum HatchStyle { diff --git a/offapi/com/sun/star/drawing/HatchTable.idl b/offapi/com/sun/star/drawing/HatchTable.idl index 59c799834822..9e709c1cf52b 100644 --- a/offapi/com/sun/star/drawing/HatchTable.idl +++ b/offapi/com/sun/star/drawing/HatchTable.idl @@ -25,9 +25,9 @@ module com { module sun { module star { module drawing { -/** this is a container for <type>Hatch</type>s +/** this is a container for Hatchs - <p>It is used for example to access the <type>Hatch</type>s that + <p>It is used for example to access the Hatchs that are used inside a document. @see DrawingDocumentFactory @@ -35,7 +35,7 @@ */ published service HatchTable { - /** this container lets you access the <type>Hatch</type>s that + /** this container lets you access the Hatchs that are indexed with a name. <p>Note: You can add new entries for later use, but you cannot diff --git a/offapi/com/sun/star/drawing/HomogenMatrixLine.idl b/offapi/com/sun/star/drawing/HomogenMatrixLine.idl index 0af612541c38..2a3063366d26 100644 --- a/offapi/com/sun/star/drawing/HomogenMatrixLine.idl +++ b/offapi/com/sun/star/drawing/HomogenMatrixLine.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** specifies a single line for a <type>HomogenMatrix</type>. +/** specifies a single line for a HomogenMatrix. */ published struct HomogenMatrixLine { diff --git a/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl b/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl index c28f7b18efc9..607e800fd513 100644 --- a/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl +++ b/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { -/** specifies a single line for a <type>HomogenMatrix3</type>. +/** specifies a single line for a HomogenMatrix3. */ published struct HomogenMatrixLine3 { diff --git a/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl b/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl index 0d68f94efafc..52c97fa5d062 100644 --- a/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl +++ b/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { -/** specifies a single line for a <type>HomogenMatrix4</type>. +/** specifies a single line for a HomogenMatrix4. */ published struct HomogenMatrixLine4 { diff --git a/offapi/com/sun/star/drawing/HorizontalDimensioning.idl b/offapi/com/sun/star/drawing/HorizontalDimensioning.idl index 4a01570254e3..4e083b2d4f85 100644 --- a/offapi/com/sun/star/drawing/HorizontalDimensioning.idl +++ b/offapi/com/sun/star/drawing/HorizontalDimensioning.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>HorizontalDimensioning</type> specifies the horizontal position +/** The HorizontalDimensioning specifies the horizontal position of the text of a dimensioning shape. */ published enum HorizontalDimensioning diff --git a/offapi/com/sun/star/drawing/Layer.idl b/offapi/com/sun/star/drawing/Layer.idl index 8d7d0b30175b..32dcde6e613e 100644 --- a/offapi/com/sun/star/drawing/Layer.idl +++ b/offapi/com/sun/star/drawing/Layer.idl @@ -28,11 +28,11 @@ /** A layer is an entity inside a document which contains shapes. - <p>There could be zero or more <type>Shape</type>s attached to + <p>There could be zero or more Shapes attached to such a layer. </p> - <p>The properties of a <type>Layer</type> instance affect all <type>Shape</type>s + <p>The properties of a Layer instance affect all Shapes attached to the Layer. </p> @@ -43,28 +43,28 @@ published service Layer { - /** The properties in this set affect all <type>Shape</type>s attached to + /** The properties in this set affect all Shapes attached to this Layer. */ interface com::sun::star::beans::XPropertySet; - /** The name of a <type>Layer</type> is used to identify the - <type>Layer</type> in the user interface. + /** The name of a Layer is used to identify the + Layer in the user interface. */ [property] string Name; - /** If a <type>Layer</type> is not visible, the objects in this - <type>Layer</type> are not shown in the user interface. + /** If a Layer is not visible, the objects in this + Layer are not shown in the user interface. */ [property] boolean IsVisible; - /** If a <type>Layer</type> is not printable, the objects in - this <type>Layer</type> are not printed. + /** If a Layer is not printable, the objects in + this Layer are not printed. */ [property] boolean IsPrintable; - /** If a <type>Layer</type> is locked, the objects in this - <type>Layer</type> cannot be edited in the user interface. + /** If a Layer is locked, the objects in this + Layer cannot be edited in the user interface. */ [property] boolean IsLocked; diff --git a/offapi/com/sun/star/drawing/LayerManager.idl b/offapi/com/sun/star/drawing/LayerManager.idl index d58241015f08..0bbf88f94862 100644 --- a/offapi/com/sun/star/drawing/LayerManager.idl +++ b/offapi/com/sun/star/drawing/LayerManager.idl @@ -27,26 +27,26 @@ module com { module sun { module star { module drawing { -/** This service is provided by documents to support <type>Layer</type>s. +/** This service is provided by documents to support Layers. @see DrawingDocument */ published service LayerManager { - /** gives you access to the existing <type>Layer</type>s by - index and makes it possible to add and remove <type>Layer</type>s and - to attach <type>Shape</type>s to <type>Layer</type>s. + /** gives you access to the existing Layers by + index and makes it possible to add and remove Layers and + to attach Shapes to Layers. - <p>The contents of the collection all support <type>Layer</type> - returned by <type>XLayer</type>. + <p>The contents of the collection all support Layer + returned by XLayer. */ interface com::sun::star::drawing::XLayerManager; - /** gives access to the existing <type>Layer</type>s by name. + /** gives access to the existing Layers by name. - <p>The contents of the collection all support <type>Layer</type> - returned by <type>XLayer</type>. + <p>The contents of the collection all support Layer + returned by XLayer. */ interface com::sun::star::container::XNameAccess; diff --git a/offapi/com/sun/star/drawing/LineCap.idl b/offapi/com/sun/star/drawing/LineCap.idl index b5dd5e78e399..a0bac79072f2 100644 --- a/offapi/com/sun/star/drawing/LineCap.idl +++ b/offapi/com/sun/star/drawing/LineCap.idl @@ -22,7 +22,7 @@ //============================================================================= module com { module sun { module star { module drawing { -/** The <type>LineCap</type> defines rendering of ends of thick lines +/** The LineCap defines rendering of ends of thick lines */ published enum LineCap { diff --git a/offapi/com/sun/star/drawing/LineDash.idl b/offapi/com/sun/star/drawing/LineDash.idl index 1633895c2553..ea0dd48f4ea0 100644 --- a/offapi/com/sun/star/drawing/LineDash.idl +++ b/offapi/com/sun/star/drawing/LineDash.idl @@ -25,15 +25,15 @@ module com { module sun { module star { module drawing { -/** A <type>LineDash</type> defines a non-continuous line. +/** A LineDash defines a non-continuous line. */ published struct LineDash { - /** This sets the style of this <type>LineDash</type>. + /** This sets the style of this LineDash. */ com::sun::star::drawing::DashStyle Style; - /** This is the number of dots in this <type>LineDash</type>. + /** This is the number of dots in this LineDash. */ short Dots; diff --git a/offapi/com/sun/star/drawing/LineEndType.idl b/offapi/com/sun/star/drawing/LineEndType.idl index 5bfe4298e807..cf817f7bfcf2 100644 --- a/offapi/com/sun/star/drawing/LineEndType.idl +++ b/offapi/com/sun/star/drawing/LineEndType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>LineEndType</type> specifies the appearance of the bullet at the +/** The LineEndType specifies the appearance of the bullet at the end of a line. @deprecated diff --git a/offapi/com/sun/star/drawing/LineJoint.idl b/offapi/com/sun/star/drawing/LineJoint.idl index f51f1b9f8934..276ddd7e9752 100644 --- a/offapi/com/sun/star/drawing/LineJoint.idl +++ b/offapi/com/sun/star/drawing/LineJoint.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>LineJoint</type> defines rendering of joints between thick lines +/** The LineJoint defines rendering of joints between thick lines */ published enum LineJoint { diff --git a/offapi/com/sun/star/drawing/LineShape.idl b/offapi/com/sun/star/drawing/LineShape.idl index 7cfdd1046cbb..24672c2342cf 100644 --- a/offapi/com/sun/star/drawing/LineShape.idl +++ b/offapi/com/sun/star/drawing/LineShape.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module drawing { -/** This service is for a simple <type>Shape</type> with lines. +/** This service is for a simple Shape with lines. */ published service LineShape { diff --git a/offapi/com/sun/star/drawing/MarkerTable.idl b/offapi/com/sun/star/drawing/MarkerTable.idl index fa8a7e6354d1..fe4761407035 100644 --- a/offapi/com/sun/star/drawing/MarkerTable.idl +++ b/offapi/com/sun/star/drawing/MarkerTable.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** this is a container for <type>PointSequence</type>s +/** this is a container for PointSequences <p>It is used for example to access the line ends that are used inside a document. @@ -35,7 +35,7 @@ */ published service MarkerTable { - /** this container lets you access the <type>PointSequence</type>s that + /** this container lets you access the PointSequences that are indexed with a name. <p>Note: You can add new entries for later use, but you cannot diff --git a/offapi/com/sun/star/drawing/MasterPage.idl b/offapi/com/sun/star/drawing/MasterPage.idl index 8f92600828ce..db99527ff964 100644 --- a/offapi/com/sun/star/drawing/MasterPage.idl +++ b/offapi/com/sun/star/drawing/MasterPage.idl @@ -28,18 +28,18 @@ /** This service is a single master page inside a drawing document. - <p>It serves as a background page for zero or more <type>DrawPage</type>s. - Since this service is derived from the service <type>GenericDrawPage</type>, + <p>It serves as a background page for zero or more DrawPages. + Since this service is derived from the service GenericDrawPage, it can be used as a draw page with three differences: </p> <ol> - <li>It is not linked to any other <type>MasterPage</type>. + <li>It is not linked to any other MasterPage. </li> <li>It cannot be removed from a document as long as one or - more instances of <type>DrawPage</type> are linked to it. + more instances of DrawPage are linked to it. </li> - <li>Modifications to a <type>MasterPage</type> are instantly visible on - every <type>DrawPage</type> that is linked to it. + <li>Modifications to a MasterPage are instantly visible on + every DrawPage that is linked to it. </li> </ol> */ diff --git a/offapi/com/sun/star/drawing/MasterPages.idl b/offapi/com/sun/star/drawing/MasterPages.idl index a10d26d1eadb..989c1c436cf1 100644 --- a/offapi/com/sun/star/drawing/MasterPages.idl +++ b/offapi/com/sun/star/drawing/MasterPages.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** provides access to a container of <type>MasterPage</type>s +/** provides access to a container of MasterPages and makes it possible for them to be manipulated. @see XMasterPagesSupplier @@ -34,7 +34,7 @@ */ published service MasterPages { - /** lets you access and create <type>MasterPage</type>s + /** lets you access and create MasterPages */ interface com::sun::star::drawing::XDrawPages; diff --git a/offapi/com/sun/star/drawing/MeasureProperties.idl b/offapi/com/sun/star/drawing/MeasureProperties.idl index 2cac68d3f3af..0e9b87f6e4be 100644 --- a/offapi/com/sun/star/drawing/MeasureProperties.idl +++ b/offapi/com/sun/star/drawing/MeasureProperties.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module drawing { -/** This service describes a <type>MeasureShape</type>. +/** This service describes a MeasureShape. */ published service MeasureProperties { @@ -56,7 +56,7 @@ published service MeasureProperties */ [property] long MeasureHelpLineOverhang; - /** This enumeration specifies the <type>MeasureKind</type>. + /** This enumeration specifies the MeasureKind. */ [property] com::sun::star::drawing::MeasureKind MeasureKind; diff --git a/offapi/com/sun/star/drawing/PluginShape.idl b/offapi/com/sun/star/drawing/PluginShape.idl index 0a5f14d32263..5dbaf86c0aaf 100644 --- a/offapi/com/sun/star/drawing/PluginShape.idl +++ b/offapi/com/sun/star/drawing/PluginShape.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** This <type>Shape</type> encapsulates a plugin. +/** This Shape encapsulates a plugin. <p>A plugin is a binary object that is plugged into a document to represent a media-type that is not handled natively by the application. @@ -34,7 +34,7 @@ published service PluginShape { /** basic service for position, size and z-order. - <p>A <type>PluginShape</type> cannot be rotated. + <p>A PluginShape cannot be rotated. */ service com::sun::star::drawing::Shape; diff --git a/offapi/com/sun/star/drawing/RectangleShape.idl b/offapi/com/sun/star/drawing/RectangleShape.idl index ffdca52e35d8..1b186580188a 100644 --- a/offapi/com/sun/star/drawing/RectangleShape.idl +++ b/offapi/com/sun/star/drawing/RectangleShape.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module drawing { -/** This service is for a rectangle <type>Shape</type>. +/** This service is for a rectangle Shape. */ published service RectangleShape { @@ -52,7 +52,7 @@ published service RectangleShape service com::sun::star::drawing::RotationDescriptor; - /** For <type>Shape</type>s with rounded corners, this is the radius + /** For Shapes with rounded corners, this is the radius of the corners. */ [property] long CornerRadius; diff --git a/offapi/com/sun/star/drawing/RotationDescriptor.idl b/offapi/com/sun/star/drawing/RotationDescriptor.idl index e183fe0038a1..1697053e88be 100644 --- a/offapi/com/sun/star/drawing/RotationDescriptor.idl +++ b/offapi/com/sun/star/drawing/RotationDescriptor.idl @@ -25,30 +25,30 @@ /** This abstract service specifies the general characteristics of an optional - rotation and shearing for a <type>Shape</type>. + rotation and shearing for a Shape. This service is deprecated, instead please use the <code>Transformation</code> - property of the service <type>Shape</type>. + property of the service Shape. @deprecated */ published service RotationDescriptor { - /** This is the angle for rotation of this <type>Shape</type>. + /** This is the angle for rotation of this Shape. The shape is rotated counter-clockwise around the center of the bounding box. This property contains an error, the rotation angle is mathematically inverted when You take into account that the Y-Axis of the coordinate system is pointing down. Please use the <code>Transformation</code> - property of the service <type>Shape</type> instead. + property of the service Shape instead. @deprecated */ [property] long RotateAngle; - /** This is the amount of shearing for this <type>Shape</type>. + /** This is the amount of shearing for this Shape. The shape is sheared counter-clockwise around the center of the bounding box diff --git a/offapi/com/sun/star/drawing/ShadeMode.idl b/offapi/com/sun/star/drawing/ShadeMode.idl index 50fc0b127386..6a6c2fe88e26 100644 --- a/offapi/com/sun/star/drawing/ShadeMode.idl +++ b/offapi/com/sun/star/drawing/ShadeMode.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>ShadeMode</type> determines the quality of displaying the object. +/** The ShadeMode determines the quality of displaying the object. */ published enum ShadeMode { diff --git a/offapi/com/sun/star/drawing/ShadowProperties.idl b/offapi/com/sun/star/drawing/ShadowProperties.idl index 838a9f5322d1..f0d783966730 100644 --- a/offapi/com/sun/star/drawing/ShadowProperties.idl +++ b/offapi/com/sun/star/drawing/ShadowProperties.idl @@ -31,14 +31,14 @@ published service ShadowProperties { - /** enables/disables the shadow of a <type>Shape</type>. + /** enables/disables the shadow of a Shape. <p>The other shadow properties are only applied if this is set to <TRUE/>.</p> */ [property] boolean Shadow; - /** This is the color of the shadow of this <type>Shape</type>. + /** This is the color of the shadow of this Shape. */ [property] com::sun::star::util::Color ShadowColor; @@ -49,13 +49,13 @@ published service ShadowProperties /** This is the horizontal distance of the left edge of the - <type>Shape</type> to the shadow. + Shape to the shadow. */ [property] long ShadowXDistance; /** This is the vertical distance of the top edge of the - <type>Shape</type> to the shadow. + Shape to the shadow. */ [property] long ShadowYDistance; diff --git a/offapi/com/sun/star/drawing/Shape.idl b/offapi/com/sun/star/drawing/Shape.idl index ded92712bb9a..3f7b16d32946 100644 --- a/offapi/com/sun/star/drawing/Shape.idl +++ b/offapi/com/sun/star/drawing/Shape.idl @@ -33,7 +33,7 @@ /** This abstract service specifies the general characteristics of all - <type>Shape</type>s. + Shapes. @see XShape @see com::sun::star::lang::XComponent @@ -48,20 +48,20 @@ published service Shape interface com::sun::star::beans::XPropertySet; - /** This gives you the size and position of this <type>Shape</type> + /** This gives you the size and position of this Shape and lets you change it. You can use <member>getShapeType</member> to determine what kind of shape this is. */ interface com::sun::star::drawing::XShape; - /** is used for lifetime control of this <type>Shape</type>. + /** is used for lifetime control of this Shape. */ interface com::sun::star::lang::XComponent; - /** The <type>XShapeDescriptor</type> tells you what kind of - <type>Shape</type> this instance is. + /** The XShapeDescriptor tells you what kind of + Shape this instance is. */ interface com::sun::star::drawing::XShapeDescriptor; @@ -76,47 +76,47 @@ published service Shape [optional] interface com::sun::star::beans::XTolerantMultiPropertySet; - /** is used to query or change the ZOrder of this <type>Shape</type>. */ + /** is used to query or change the ZOrder of this Shape. */ [optional, property] long ZOrder; - /** This is the ID of the <type>Layer</type> to which this - <type>Shape</type> is attached. + /** This is the ID of the Layer to which this + Shape is attached. */ [optional, property] short LayerID; - /** This is the name of the <type>Layer</type> to which this - <type>Shape</type> is attached. + /** This is the name of the Layer to which this + Shape is attached. */ [optional, property] string LayerName; - /** If this is <FALSE/>, the <type>Shape</type> is not visible - on screen outputs. Please note that the <type>Shape</type> may still + /** If this is <FALSE/>, the Shape is not visible + on screen outputs. Please note that the Shape may still be visible when printed, see <member>Printable</member>. */ [optional, property] boolean Visible; - /** If this is <FALSE/>, the <type>Shape</type> is not visible + /** If this is <FALSE/>, the Shape is not visible on printer outputs. */ [optional, property] boolean Printable; - /** With this set to <TRUE/>, this <type>Shape</type> + /** With this set to <TRUE/>, this Shape cannot be moved interactively in the user interface. */ [optional, property] boolean MoveProtect; - /** This is the name of this <type>Shape</type>. + /** This is the name of this Shape. */ [optional, property] string Name; - /** With this set to <TRUE/>, this <type>Shape</type> may not be + /** With this set to <TRUE/>, this Shape may not be sized interactively in the user interface. */ [optional, property] boolean SizeProtect; diff --git a/offapi/com/sun/star/drawing/ShapeCollection.idl b/offapi/com/sun/star/drawing/ShapeCollection.idl index b126177458dd..38acd173c3de 100644 --- a/offapi/com/sun/star/drawing/ShapeCollection.idl +++ b/offapi/com/sun/star/drawing/ShapeCollection.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module drawing { /** This service describes a generic container to manage collections of - <type>Shape</type>. The <type>Shape</type> that are added to this + Shape. The Shape that are added to this collection are not owned by the collection. This service is used by the view f.e. to return a collection of - <type>Shape</type> that are selected at the ui. + Shape that are selected at the ui. */ published service ShapeCollection : com::sun::star::drawing::XShapes; diff --git a/offapi/com/sun/star/drawing/Text.idl b/offapi/com/sun/star/drawing/Text.idl index dbc4e98902af..0749c4610a10 100644 --- a/offapi/com/sun/star/drawing/Text.idl +++ b/offapi/com/sun/star/drawing/Text.idl @@ -28,7 +28,7 @@ /** This abstract service specifies the general characteristics of an optional - text inside a <type>Shape</type>. + text inside a Shape. */ published service Text { diff --git a/offapi/com/sun/star/drawing/TextProperties.idl b/offapi/com/sun/star/drawing/TextProperties.idl index ddde3987cf88..6cb102034e52 100644 --- a/offapi/com/sun/star/drawing/TextProperties.idl +++ b/offapi/com/sun/star/drawing/TextProperties.idl @@ -52,42 +52,42 @@ published service TextProperties { /** The properties in this service set default formats for text - inside the <type>Shape</type>. + inside the Shape. */ service com::sun::star::style::CharacterProperties; /** The properties in this service set default formats for Asian text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::CharacterPropertiesAsian; /** The properties in this service set default formats for complex text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::CharacterPropertiesComplex; /** The properties in this service set default formats for text - inside the <type>Shape</type>. + inside the Shape. */ service com::sun::star::style::ParagraphProperties; /** The properties in this service set default formats for Asian text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::ParagraphPropertiesAsian; /** The properties in this service set default formats for complex text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::ParagraphPropertiesComplex; /** If this is <TRUE/>, numbering is ON for the text of - this <type>Shape</type>. + this Shape. */ [optional, property] boolean IsNumbering; @@ -101,44 +101,44 @@ published service TextProperties [optional, property] com::sun::star::container::XIndexReplace NumberingRules; - /** If this value is <TRUE/>, the height of the <type>Shape</type> is + /** If this value is <TRUE/>, the height of the Shape is automatically expanded/shrunk when text is added to or removed from - the <type>Shape</type>. + the Shape. */ [property] boolean TextAutoGrowHeight; - /** If this value is <TRUE/>, the width of the <type>Shape</type> is + /** If this value is <TRUE/>, the width of the Shape is automatically expanded/shrunk when text is added to or removed from - the <type>Shape</type>. + the Shape. */ [property] boolean TextAutoGrowWidth; /** If this value is <TRUE/>, the left edge of every line of text is - aligned with the left edge of this <type>Shape</type>. + aligned with the left edge of this Shape. */ [property] boolean TextContourFrame; - /** With this set to <TRUE/>, the text inside of the <type>Shape</type> - is stretched to fit into the <type>Shape</type>. + /** With this set to <TRUE/>, the text inside of the Shape + is stretched to fit into the Shape. */ [property] com::sun::star::drawing::TextFitToSizeType TextFitToSize; /** adjusts the horizontal position of the text inside of - the <type>Shape</type>. + the Shape. */ [property] com::sun::star::drawing::TextHorizontalAdjust TextHorizontalAdjust; /** adjusts the vertical position of the text inside of - the <type>Shape</type>. + the Shape. */ [property] com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust; - /** This is the distance from the left edge of the <type>Shape</type> + /** This is the distance from the left edge of the Shape to the left edge of the text. <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is <const>BLOCK</const> or <const>STRETCH</const> or if @@ -147,7 +147,7 @@ published service TextProperties [property] long TextLeftDistance; - /** This is the distance from the right edge of the <type>Shape</type> + /** This is the distance from the right edge of the Shape to the right edge of the text. <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is @@ -157,7 +157,7 @@ published service TextProperties [property] long TextRightDistance; - /** This is the distance from the upper edge of the <type>Shape</type> to + /** This is the distance from the upper edge of the Shape to the upper edge of the text. <p>This is only useful if <member>Text::TextVerticalAdjust</member> is @@ -167,7 +167,7 @@ published service TextProperties [property] long TextUpperDistance; - /** This is the distance from the lower edge of the <type>Shape</type> to the + /** This is the distance from the lower edge of the Shape to the lower edge of the text. diff --git a/offapi/com/sun/star/drawing/TextureKind.idl b/offapi/com/sun/star/drawing/TextureKind.idl index 26df3ddd1d15..5d2e0e19ba66 100644 --- a/offapi/com/sun/star/drawing/TextureKind.idl +++ b/offapi/com/sun/star/drawing/TextureKind.idl @@ -28,7 +28,7 @@ */ published enum TextureKind { - /** With <type>TextureKind</type> <const>LUMINANCE</const>, the texture + /** With TextureKind <const>LUMINANCE</const>, the texture and the lighting information are mixed to produce the image, so a lit, textured object is achieved. */ diff --git a/offapi/com/sun/star/drawing/TextureKind2.idl b/offapi/com/sun/star/drawing/TextureKind2.idl index a0ac83cdc9b7..9b49a967ef64 100644 --- a/offapi/com/sun/star/drawing/TextureKind2.idl +++ b/offapi/com/sun/star/drawing/TextureKind2.idl @@ -29,13 +29,13 @@ published enum TextureKind2 { - /** With <type>TextureKind</type> <const>LUMINANCE</const>, the texture + /** With TextureKind <const>LUMINANCE</const>, the texture and the lighting information are mixed to produce the image, so a lit, textured object is achieved. */ LUMINANCE, - /** With <type>TextureKind</type> <const>INTENSITY</const>, each texture + /** With TextureKind <const>INTENSITY</const>, each texture pixel is used as an intensity value. */ INTENSITY, diff --git a/offapi/com/sun/star/drawing/TextureMode.idl b/offapi/com/sun/star/drawing/TextureMode.idl index 1aa72debd0c8..31f39869fe60 100644 --- a/offapi/com/sun/star/drawing/TextureMode.idl +++ b/offapi/com/sun/star/drawing/TextureMode.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>TextureMode</type> defines in which way the texture color data +/** The TextureMode defines in which way the texture color data replaces the object color data. */ published enum TextureMode diff --git a/offapi/com/sun/star/drawing/XConnectorShape.idl b/offapi/com/sun/star/drawing/XConnectorShape.idl index 299634b90aab..9e89224860bb 100644 --- a/offapi/com/sun/star/drawing/XConnectorShape.idl +++ b/offapi/com/sun/star/drawing/XConnectorShape.idl @@ -44,12 +44,12 @@ published interface XConnectorShape: com::sun::star::drawing::XShape void connectEnd( [in] com::sun::star::drawing::XConnectableShape xShape, [in] com::sun::star::drawing::ConnectionType nPos ); - /** disconnects the given <type>Shape</type> from the start of + /** disconnects the given Shape from the start of this instance. */ void disconnectBegin( [in] com::sun::star::drawing::XConnectableShape xShape ); - /** disconnects the given <type>Shape</type> from the end of + /** disconnects the given Shape from the end of this instance. */ void disconnectEnd( [in] com::sun::star::drawing::XConnectableShape xShape ); diff --git a/offapi/com/sun/star/drawing/XControlShape.idl b/offapi/com/sun/star/drawing/XControlShape.idl index f4ab56a02248..11d64077992b 100644 --- a/offapi/com/sun/star/drawing/XControlShape.idl +++ b/offapi/com/sun/star/drawing/XControlShape.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** is implemented by a <type>ControlShape</type> to access the controls model. +/** is implemented by a ControlShape to access the controls model. @see com::sun::star::drawing::ControlShape @see com::sun::star::awt::UnoControlModel @@ -36,23 +36,23 @@ published interface XControlShape: com::sun::star::drawing::XShape { - /** returns the control model of this <type>Shape</type>. + /** returns the control model of this Shape. @return if there is already a control model assigned - to this <type>ControlShape</type>, than its returned. + to this ControlShape, than its returned. Otherwise you get an empty reference. */ com::sun::star::awt::XControlModel getControl(); - /** sets the control model for this <type>Shape</type>. + /** sets the control model for this Shape. @param xControl this will be the new control model that is displayed with this shape. You may change the model more than once during the lifetime - of a <type>ControlShape</type> + of a ControlShape */ void setControl( [in] com::sun::star::awt::XControlModel xControl ); diff --git a/offapi/com/sun/star/drawing/XDrawPage.idl b/offapi/com/sun/star/drawing/XDrawPage.idl index 897e17be770f..1ebf020e4f8d 100644 --- a/offapi/com/sun/star/drawing/XDrawPage.idl +++ b/offapi/com/sun/star/drawing/XDrawPage.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** identifies an <type>XShapes</type> as a <type>DrawPage</type>. +/** identifies an XShapes as a DrawPage. */ published interface XDrawPage: com::sun::star::drawing::XShapes { diff --git a/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl b/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl index 42ea2d5ff596..e1ee7014a138 100644 --- a/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl +++ b/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl @@ -33,17 +33,17 @@ published interface XDrawPageDuplicator: com::sun::star::uno::XInterface { - /** creates a duplicate of a <type>DrawPage</type> or <type>MasterPage</type>, - including the <type>Shape</type>s on that page and inserts it into the + /** creates a duplicate of a DrawPage or MasterPage, + including the Shapes on that page and inserts it into the same model. @param xPage - that is the source <type>DrawPage</type> or <type>MasterPage</type> + that is the source DrawPage or MasterPage that will be duplicated @return - a newly created <type>DrawPage</type> or <type>MasterPage</type> - that as all properties and copies of all <type>Shape</type>s from + a newly created DrawPage or MasterPage + that as all properties and copies of all Shapes from the source page. */ com::sun::star::drawing::XDrawPage duplicate( [in] com::sun::star::drawing::XDrawPage xPage ); diff --git a/offapi/com/sun/star/drawing/XDrawPageExpander.idl b/offapi/com/sun/star/drawing/XDrawPageExpander.idl index 59c1127a94e1..383ca343dabf 100644 --- a/offapi/com/sun/star/drawing/XDrawPageExpander.idl +++ b/offapi/com/sun/star/drawing/XDrawPageExpander.idl @@ -31,8 +31,8 @@ /** is implemented by documents that can expand the contents - of a summary on a <type>DrawPage</type> into a collection of - <type>DrawPage</type>s. + of a summary on a DrawPage into a collection of + DrawPages. @see XDrawPageSummarizer @@ -41,9 +41,9 @@ published interface XDrawPageExpander: com::sun::star::uno::XInterface { - /** creates a collection of <type>DrawPage</type>s from the - summary inside the given <type>DrawPage</type> and adds - them to the same model as the source <type>DrawPage</type>. + /** creates a collection of DrawPages from the + summary inside the given DrawPage and adds + them to the same model as the source DrawPage. */ com::sun::star::drawing::XDrawPages expand( [in] com::sun::star::drawing::XDrawPage xPage ); diff --git a/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl b/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl index 3bb732743c01..5da5018aa06c 100644 --- a/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl +++ b/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl @@ -30,14 +30,14 @@ module com { module sun { module star { module drawing { /** is implemented by documents that can create summaries - of their <type>DrawPage</type>s. + of their DrawPages. @deprecated */ published interface XDrawPageSummarizer: com::sun::star::uno::XInterface { - /** creates a new <type>DrawPage</type> with a summary of all - <type>DrawPage</type>s in the given collection. + /** creates a new DrawPage with a summary of all + DrawPages in the given collection. */ com::sun::star::drawing::XDrawPage summarize( [in] com::sun::star::drawing::XDrawPages xPages ); diff --git a/offapi/com/sun/star/drawing/XDrawPageSupplier.idl b/offapi/com/sun/star/drawing/XDrawPageSupplier.idl index f20bd9cdb155..6c4856986dfc 100644 --- a/offapi/com/sun/star/drawing/XDrawPageSupplier.idl +++ b/offapi/com/sun/star/drawing/XDrawPageSupplier.idl @@ -27,18 +27,18 @@ module com { module sun { module star { module drawing { -/** represents something that provides a <type>DrawPage</type>. +/** represents something that provides a DrawPage. <p>This interface is provided if the container only supports exactly - one <type>DrawPage</type>. For containers which support multiple - <type>DrawPage</type>s interface <type>XDrawPagesSupplier</type> is + one DrawPage. For containers which support multiple + DrawPages interface XDrawPagesSupplier is supported.</p> @deprecated */ published interface XDrawPageSupplier: com::sun::star::uno::XInterface { - /** returns the <type>DrawPage</type>. + /** returns the DrawPage. */ com::sun::star::drawing::XDrawPage getDrawPage(); diff --git a/offapi/com/sun/star/drawing/XDrawPages.idl b/offapi/com/sun/star/drawing/XDrawPages.idl index b5134d25c6ba..4ee185dd4549 100644 --- a/offapi/com/sun/star/drawing/XDrawPages.idl +++ b/offapi/com/sun/star/drawing/XDrawPages.idl @@ -28,37 +28,37 @@ module com { module sun { module star { module drawing { -/** gives access to a container of <type>DrawPage</type>s or <type>MasterPage</type>s. +/** gives access to a container of DrawPages or MasterPages. <p>The pages are stored in an index container. The order is determined by the index. You usually get this interface if you use the - <type>XDrawPagesSupplier</type> or the <type>XMasterPagesSupplier</type> - at a model that contains <type>DrawPage</type>s or <type>MasterPage</type>s + XDrawPagesSupplier or the XMasterPagesSupplier + at a model that contains DrawPages or MasterPages */ published interface XDrawPages: com::sun::star::container::XIndexAccess { - /** creates and inserts a new <type>DrawPage</type> or <type>MasterPage</type> + /** creates and inserts a new DrawPage or MasterPage into this container @param nIndex - the index at which the newly created <type>DrawPage</type> or - <type>MasterPage</type> will be inserted. + the index at which the newly created DrawPage or + MasterPage will be inserted. @return - the newly created and already inserted <type>DrawPage</type> or - <type>MasterPage</type>. + the newly created and already inserted DrawPage or + MasterPage. */ com::sun::star::drawing::XDrawPage insertNewByIndex( [in] long nIndex ); - /** removes a <type>DrawPage</type> or <type>MasterPage</type> from this + /** removes a DrawPage or MasterPage from this container. @param xPage - this <type>DrawPage</type> or <type>MasterPage</type> must be + this DrawPage or MasterPage must be contained and will be removed from this container. It will also be disposed and shouldn't be used any further. */ diff --git a/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl b/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl index 32ba7da84401..33d21b137ce2 100644 --- a/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl +++ b/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl @@ -34,7 +34,7 @@ published interface XDrawPagesSupplier: com::sun::star::uno::XInterface { /** @returns - an indexed container with the service <type>DrawPages</type>. + an indexed container with the service DrawPages. */ com::sun::star::drawing::XDrawPages getDrawPages(); diff --git a/offapi/com/sun/star/drawing/XDrawView.idl b/offapi/com/sun/star/drawing/XDrawView.idl index 6aa8cd08cb85..40ebfe024cf0 100644 --- a/offapi/com/sun/star/drawing/XDrawView.idl +++ b/offapi/com/sun/star/drawing/XDrawView.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** is implemented by views that display <type>DrawPage</type>s or <type>MasterPage</type>s. +/** is implemented by views that display DrawPages or MasterPages. */ published interface XDrawView: com::sun::star::uno::XInterface { @@ -36,7 +36,7 @@ published interface XDrawView: com::sun::star::uno::XInterface /** changes the current page. @param xPage - this <type>DrawPage</type> or <type>MasterPage</type> will be + this DrawPage or MasterPage will be displayed inside this view. */ void setCurrentPage( [in] com::sun::star::drawing::XDrawPage xPage ); @@ -45,7 +45,7 @@ published interface XDrawView: com::sun::star::uno::XInterface /** returns the current page. @return - the <type>DrawPage</type> or <type>MasterPage</type> that is + the DrawPage or MasterPage that is currently displayed. */ com::sun::star::drawing::XDrawPage getCurrentPage(); diff --git a/offapi/com/sun/star/drawing/XGluePointsSupplier.idl b/offapi/com/sun/star/drawing/XGluePointsSupplier.idl index 7343a414c40c..8e129ba12a64 100644 --- a/offapi/com/sun/star/drawing/XGluePointsSupplier.idl +++ b/offapi/com/sun/star/drawing/XGluePointsSupplier.idl @@ -25,14 +25,14 @@ module com { module sun { module star { module drawing { -/** must be supported to provide access to a container of <type>GluePoint2</type>. +/** must be supported to provide access to a container of GluePoint2. */ published interface XGluePointsSupplier: com::sun::star::uno::XInterface { /** @return - a container of <type>GluePoint2</type> structs. + a container of GluePoint2 structs. */ com::sun::star::container::XIndexContainer getGluePoints(); diff --git a/offapi/com/sun/star/drawing/XGraphicExportFilter.idl b/offapi/com/sun/star/drawing/XGraphicExportFilter.idl index 81418c413221..8adff804d2bc 100644 --- a/offapi/com/sun/star/drawing/XGraphicExportFilter.idl +++ b/offapi/com/sun/star/drawing/XGraphicExportFilter.idl @@ -76,8 +76,8 @@ published interface XGraphicExportFilter interface ::com::sun::star::document::XFilter; /** sets the source component for this export filter. - <p>This could either be a <type>DrawPage</type>, a <type>Shape</type> - or a <type>Shapes</type>.</p> + <p>This could either be a DrawPage, a Shape + or a Shapes.</p> */ interface ::com::sun::star::document::XExporter; diff --git a/offapi/com/sun/star/drawing/XLayer.idl b/offapi/com/sun/star/drawing/XLayer.idl index b72ef53c8d8a..82933d37e8cc 100644 --- a/offapi/com/sun/star/drawing/XLayer.idl +++ b/offapi/com/sun/star/drawing/XLayer.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** identifies the object as a <type>Layer</type>. +/** identifies the object as a Layer. */ published interface XLayer: com::sun::star::beans::XPropertySet { diff --git a/offapi/com/sun/star/drawing/XLayerManager.idl b/offapi/com/sun/star/drawing/XLayerManager.idl index c2f7539e1c12..58c0d4db00e3 100644 --- a/offapi/com/sun/star/drawing/XLayerManager.idl +++ b/offapi/com/sun/star/drawing/XLayerManager.idl @@ -33,53 +33,53 @@ /** This interface makes it possible to access and manage the - <type>Layer</type>s of a document. + Layers of a document. @see LayerManager */ published interface XLayerManager: com::sun::star::container::XIndexAccess { - /** creates a new <type>Layer</type> + /** creates a new Layer @param nIndex the index at which the new layer is inserted @returns - the new created <type>Layer</type> + the new created Layer */ com::sun::star::drawing::XLayer insertNewByIndex( [in] long nIndex ); - /** removes a <type>Layer</type> and all <type>Shape</type>s on - this <type>Layer</type>. + /** removes a Layer and all Shapes on + this Layer. @param xLayer - this <type>Layer</type> will be removed and disposed + this Layer will be removed and disposed */ void remove( [in] com::sun::star::drawing::XLayer xLayer ) raises( com::sun::star::container::NoSuchElementException ); - /** attaches a <type>Shape</type> to the given <type>Layer</type>. + /** attaches a Shape to the given Layer. @param xShape - this is the <type>Shape</type> that will be attached to a <type>Layer</type> + this is the Shape that will be attached to a Layer @param xLayer - this is the <type>Layer</type> that will be attached to a <type>Shape</type> + this is the Layer that will be attached to a Shape */ void attachShapeToLayer( [in] com::sun::star::drawing::XShape xShape, [in] com::sun::star::drawing::XLayer xLayer ); - /** queries the <type>Layer</type> that a <type>Shape</type> is attached to + /** queries the Layer that a Shape is attached to @param xShape - specifies the <type>Shape</type> for which the layer is requested. + specifies the Shape for which the layer is requested. @returns - the <type>Layer</type> to which the <type>Shape</type> is + the Layer to which the Shape is attached. */ diff --git a/offapi/com/sun/star/drawing/XLayerSupplier.idl b/offapi/com/sun/star/drawing/XLayerSupplier.idl index 416040904393..3e2bfe151247 100644 --- a/offapi/com/sun/star/drawing/XLayerSupplier.idl +++ b/offapi/com/sun/star/drawing/XLayerSupplier.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** gives access to a <type>LayerManager</type>. +/** gives access to a LayerManager. @see LayerManager */ @@ -36,7 +36,7 @@ published interface XLayerSupplier: com::sun::star::uno::XInterface { /** @returns - the <type>LayerManager</type>. + the LayerManager. */ com::sun::star::container::XNameAccess getLayerManager(); diff --git a/offapi/com/sun/star/drawing/XMasterPageTarget.idl b/offapi/com/sun/star/drawing/XMasterPageTarget.idl index 63246307f875..849a339eef7b 100644 --- a/offapi/com/sun/star/drawing/XMasterPageTarget.idl +++ b/offapi/com/sun/star/drawing/XMasterPageTarget.idl @@ -29,22 +29,22 @@ /** is implemented by objects that can be linked to a - <type>MasterPage</type>. + MasterPage. @see DrawPage */ published interface XMasterPageTarget: com::sun::star::uno::XInterface { - /** @returns the <type>MasterPage</type> linked to this object. + /** @returns the MasterPage linked to this object. */ com::sun::star::drawing::XDrawPage getMasterPage(); - /** links a <type>MasterPage</type> to this object. + /** links a MasterPage to this object. @param xMasterPage - the <type>MasterPage</type> that is linked to this object + the MasterPage that is linked to this object */ void setMasterPage( [in] com::sun::star::drawing::XDrawPage xMasterPage ); diff --git a/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl b/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl index fe05296ccdae..74d3474d1ab0 100644 --- a/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl +++ b/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl @@ -29,13 +29,13 @@ /** must be supported to provide access to the - <type>MasterPage</type>s of a multi-page drawing-layer. + MasterPages of a multi-page drawing-layer. */ published interface XMasterPagesSupplier: com::sun::star::uno::XInterface { /** @returns - an indexed container with the service <type>MasterPages</type>. + an indexed container with the service MasterPages. */ com::sun::star::drawing::XDrawPages getMasterPages(); diff --git a/offapi/com/sun/star/drawing/XPresenterHelper.idl b/offapi/com/sun/star/drawing/XPresenterHelper.idl index 6d40c6af3c9b..12f1bc25457b 100644 --- a/offapi/com/sun/star/drawing/XPresenterHelper.idl +++ b/offapi/com/sun/star/drawing/XPresenterHelper.idl @@ -92,7 +92,7 @@ interface XPresenterHelper The canvas is created for this window. Must not be <NULL/> @param nRequestedCanvasFeatureList List of requested features that the new canvas should (has to) - provide. Use only values from the <type>CanvasFeature</type> + provide. Use only values from the CanvasFeature constants group. @param sOptionalCanvasServiceName When an explicit service name is given then a new object of this diff --git a/offapi/com/sun/star/drawing/XShape.idl b/offapi/com/sun/star/drawing/XShape.idl index 2af303f9e809..6be9c01c50d9 100644 --- a/offapi/com/sun/star/drawing/XShape.idl +++ b/offapi/com/sun/star/drawing/XShape.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module drawing { -/** lets you do a basic transformation on a <type>Shape</type> and +/** lets you do a basic transformation on a Shape and get its type. */ published interface XShape: com::sun::star::drawing::XShapeDescriptor diff --git a/offapi/com/sun/star/drawing/XShapeAligner.idl b/offapi/com/sun/star/drawing/XShapeAligner.idl index 97642697dbb0..b667b4b7bcd2 100644 --- a/offapi/com/sun/star/drawing/XShapeAligner.idl +++ b/offapi/com/sun/star/drawing/XShapeAligner.idl @@ -30,13 +30,13 @@ module com { module sun { module star { module drawing { /** Objects implementing this interface can be used to align - <type>Shape</type>s. + Shapes. @deprecated */ published interface XShapeAligner: com::sun::star::uno::XInterface { - /** aligns the specified <type>Shape</type>s. + /** aligns the specified Shapes. */ void alignShapes( [inout] com::sun::star::drawing::XShapes aShapes, [in] com::sun::star::drawing::Alignment eType ); diff --git a/offapi/com/sun/star/drawing/XShapeArranger.idl b/offapi/com/sun/star/drawing/XShapeArranger.idl index 742a0b84d3ec..8079ffd3ba9e 100644 --- a/offapi/com/sun/star/drawing/XShapeArranger.idl +++ b/offapi/com/sun/star/drawing/XShapeArranger.idl @@ -32,44 +32,44 @@ module com { module sun { module star { module drawing { /** Objects implementing this interface can be used to arrange - <type>Shape</type>s. + Shapes. @deprecated */ published interface XShapeArranger: com::sun::star::uno::XInterface { - /** applies the specified <type>Arrangement</type> to - the specified collection of <type>Shape</type>s. + /** applies the specified Arrangement to + the specified collection of Shapes. */ void arrange( [in] com::sun::star::drawing::XShapes xShapes, [in] com::sun::star::drawing::Arrangement eType ); - /** moves the specified <type>Shape</type>s by a specified number + /** moves the specified Shapes by a specified number of objects more to the front. */ void bringToFront( [in] com::sun::star::drawing::XShapes xShapes, [in] short nSteps ); - /** moves the specified <type>Shape</type>s + /** moves the specified Shapes <var>nSteps</var> objects more to the back. */ void sendToBack( [in] com::sun::star::drawing::XShapes xShapes, [in] short nSteps ); - /** moves the specified collection of <type>Shape</type>s - behind the specified single <type>Shape</type>. + /** moves the specified collection of Shapes + behind the specified single Shape. */ void setBehindShape( [in] com::sun::star::drawing::XShapes xShapes, [in] com::sun::star::drawing::XShape xShape ); - /** moves the specified collection of <type>Shape</type>s in - front of the specified single <type>Shape</type>. + /** moves the specified collection of Shapes in + front of the specified single Shape. */ void setInFrontOf( [in] com::sun::star::drawing::XShapes xShapes, [in] com::sun::star::drawing::XShape xShape ); /** reverses the order of the specified collection of - <type>Shape</type>s. + Shapes. */ void reverseOrder( [in] com::sun::star::drawing::XShapes xShapes ); diff --git a/offapi/com/sun/star/drawing/XShapeBinder.idl b/offapi/com/sun/star/drawing/XShapeBinder.idl index bb56bdecaa78..92f4acce80e4 100644 --- a/offapi/com/sun/star/drawing/XShapeBinder.idl +++ b/offapi/com/sun/star/drawing/XShapeBinder.idl @@ -30,34 +30,34 @@ module com { module sun { module star { module drawing { -/** connects or breaks the lines of <type>Shape</type>s +/** connects or breaks the lines of Shapes */ published interface XShapeBinder: com::sun::star::uno::XInterface { - /** binds <type>Shape</type>s together. + /** binds Shapes together. @param xShapes - a container with <type>Shape</type>s that will be bind together. - All <type>Shapes</type> will be converted to a <type>PolyPolygonBezierShape</type> + a container with Shapes that will be bind together. + All Shapes will be converted to a PolyPolygonBezierShape and the lines will be connected. The <type>Shape</types>s in xShape will be - removed from the <type>GenericDrawPage</type> and disposed. + removed from the GenericDrawPage and disposed. @returns - a newly created <type>PolyPolygonBezierShape</type> which contains all - line segment from the supplied <type>Shape</type>s. It is also added - to the <type>GenericDrawPage</type> of the source <type>Shape</type>s. + a newly created PolyPolygonBezierShape which contains all + line segment from the supplied Shapes. It is also added + to the GenericDrawPage of the source Shapes. */ com::sun::star::drawing::XShape bind( [in] com::sun::star::drawing::XShapes xShapes ); - /** breaks a <type>Shape</type> into its line segments + /** breaks a Shape into its line segments @param xShape - the given <type>Shape</type> will be converted to a <type>PolyPolygonBezierShape</type> - and the line segments of this <type>Shape</type> will be used to create - new <type>PolyPolygonBezierShape</type> shapes. The original <type>Shape</type> - will be removed from its <type>GenericDrawPage</type> and disposed. + the given Shape will be converted to a PolyPolygonBezierShape + and the line segments of this Shape will be used to create + new PolyPolygonBezierShape shapes. The original Shape + will be removed from its GenericDrawPage and disposed. */ void unbind( [in] com::sun::star::drawing::XShape xShape ); diff --git a/offapi/com/sun/star/drawing/XShapeCombiner.idl b/offapi/com/sun/star/drawing/XShapeCombiner.idl index 299335d6261b..9940fc3c6421 100644 --- a/offapi/com/sun/star/drawing/XShapeCombiner.idl +++ b/offapi/com/sun/star/drawing/XShapeCombiner.idl @@ -35,32 +35,32 @@ published interface XShapeCombiner: com::sun::star::uno::XInterface { - /** combines <type>Shape</type>s + /** combines Shapes @param xShapes - the <type>Shape</type>s inside this container are converted - to <type>PolyPolygonBezierShape</type>s and are than combined - into one <type>PolyPolygonBezierShape</type>. + the Shapes inside this container are converted + to PolyPolygonBezierShapes and are than combined + into one PolyPolygonBezierShape. The <type>Shape</types>s in xShape will be removed from the - <type>GenericDrawPage</type> and disposed. + GenericDrawPage and disposed. @returns - a newly created <type>PolyPolygonBezierShape</type> which contains all - converted <type>PolyPolygonBezierShape</type> combined. It is also added - to the <type>GenericDrawPage</type> of the source <type>Shape</type>s. + a newly created PolyPolygonBezierShape which contains all + converted PolyPolygonBezierShape combined. It is also added + to the GenericDrawPage of the source Shapes. */ com::sun::star::drawing::XShape combine( [in] com::sun::star::drawing::XShapes xShapes ); - /** splits <type>Shape</type>s. + /** splits Shapes. @param xShapes - the <type>Shape</type> is converted to a - <type>PolyPolygonBezierShape</type>s and then split into - several <type>PolyPolygonBezierShape</type>s + the Shape is converted to a + PolyPolygonBezierShapes and then split into + several PolyPolygonBezierShapes The <type>Shape</types>s in xShape will be removed from the - <type>GenericDrawPage</type> and disposed. + GenericDrawPage and disposed. */ void split( [in] com::sun::star::drawing::XShape xGroup ); diff --git a/offapi/com/sun/star/drawing/XShapeGroup.idl b/offapi/com/sun/star/drawing/XShapeGroup.idl index a3165d52428e..75ba24dec228 100644 --- a/offapi/com/sun/star/drawing/XShapeGroup.idl +++ b/offapi/com/sun/star/drawing/XShapeGroup.idl @@ -26,15 +26,15 @@ module com { module sun { module star { module drawing { -/** is implemented by <type>Shape</type>s that contain other - <type>Shape</type>s. +/** is implemented by Shapes that contain other + Shapes. @deprecated */ published interface XShapeGroup: com::sun::star::drawing::XShape { /** enters the group which enables the editing function - for the parts of a grouped <type>Shape</type>. Then the parts can + for the parts of a grouped Shape. Then the parts can be edited instead of the group as a whole. @@ -46,7 +46,7 @@ published interface XShapeGroup: com::sun::star::drawing::XShape void enterGroup(); /** leaves the group, which disables the editing function - for the parts of a grouped <type>Shape</type>. Then only the + for the parts of a grouped Shape. Then only the group as a whole can be edited. diff --git a/offapi/com/sun/star/drawing/XShapeGrouper.idl b/offapi/com/sun/star/drawing/XShapeGrouper.idl index d22e6b0a1b2f..c2bf90a1efea 100644 --- a/offapi/com/sun/star/drawing/XShapeGrouper.idl +++ b/offapi/com/sun/star/drawing/XShapeGrouper.idl @@ -35,7 +35,7 @@ published interface XShapeGrouper: com::sun::star::uno::XInterface { - /** groups the <type>Shape</type>s inside a collection. + /** groups the Shapes inside a collection. <p>Grouping of objects in text documents works only if none of the objects has an anchor of type @@ -43,25 +43,25 @@ published interface XShapeGrouper: com::sun::star::uno::XInterface </p>. @param xShapes - the <type>Shape</type>s that will be grouped. They - must all be inserted into the same <type>GenericDrawPage</type>. + the Shapes that will be grouped. They + must all be inserted into the same GenericDrawPage. @returns - a newly created <type>GroupShape</type> that contains all - <type>Shape</type>s from xShapes and is also added to the - <type>GenericDrawPage</type> of the <type>Shape</type>s + a newly created GroupShape that contains all + Shapes from xShapes and is also added to the + GenericDrawPage of the Shapes in xShapes. */ com::sun::star::drawing::XShapeGroup group( [in] com::sun::star::drawing::XShapes xShapes ); - /** ungroups a given <type>GroupShape</type>. + /** ungroups a given GroupShape. @param aGroup - moves all <type>Shape</type>s from this <type>GroupShape</type> - to the parent <type>XShapes</type> of the <type>GroupShape</type>. - The <type>GroupShape</type> is than removed from the - <type>GenericDrawPage</type> and disposed. + moves all Shapes from this GroupShape + to the parent XShapes of the GroupShape. + The GroupShape is than removed from the + GenericDrawPage and disposed. */ void ungroup( [in] com::sun::star::drawing::XShapeGroup aGroup ); diff --git a/offapi/com/sun/star/drawing/XShapeMirror.idl b/offapi/com/sun/star/drawing/XShapeMirror.idl index 713f840c08f5..efe8a6058d2f 100644 --- a/offapi/com/sun/star/drawing/XShapeMirror.idl +++ b/offapi/com/sun/star/drawing/XShapeMirror.idl @@ -33,21 +33,21 @@ /** Objects implementing this interface can be used to mirror - <type>Shape</type>s. + Shapes. @deprecated */ published interface XShapeMirror: com::sun::star::uno::XInterface { - /** mirrors the given <type>Shape</type>s + /** mirrors the given Shapes at the given axis. */ void mirror( [inout] com::sun::star::drawing::XShapes aShapes, [in] com::sun::star::drawing::MirrorAxis eAxis ); - /** mirrors the given <type>Shape</type>s at + /** mirrors the given Shapes at the given axis. */ void mirrorAtAxis( [inout] com::sun::star::drawing::XShapes aShapes, diff --git a/offapi/com/sun/star/drawing/XShapes.idl b/offapi/com/sun/star/drawing/XShapes.idl index 8d377618b287..54bb1d9c8074 100644 --- a/offapi/com/sun/star/drawing/XShapes.idl +++ b/offapi/com/sun/star/drawing/XShapes.idl @@ -29,7 +29,7 @@ /** makes it possible to access, add, and remove the - <type>Shape</type>s in a collection. + Shapes in a collection. @see DrawPage @see MasterPage @@ -38,18 +38,18 @@ published interface XShapes: com::sun::star::container::XIndexAccess { - /** inserts a <type>Shape</type> into this collection. + /** inserts a Shape into this collection. @param xShape - a <type>Shape</type> that will be inserted. + a Shape that will be inserted. */ void add( [in] com::sun::star::drawing::XShape xShape ); - /** removes a <type>Shape</type> from this collection. + /** removes a Shape from this collection. @param xShape - the <type>Shape</type> will be removed from the + the Shape will be removed from the collection and disposed. */ void remove( [in] com::sun::star::drawing::XShape xShape ); diff --git a/offapi/com/sun/star/drawing/XSlideRenderer.idl b/offapi/com/sun/star/drawing/XSlideRenderer.idl index 319cc63f0148..ef3e1d7ecb53 100644 --- a/offapi/com/sun/star/drawing/XSlideRenderer.idl +++ b/offapi/com/sun/star/drawing/XSlideRenderer.idl @@ -67,8 +67,8 @@ interface XSlideRenderer /** Exactly the same functionality as <member>createPreview()</member>, only a different return type: - <type>com::sun::star::rendering::XBitmap</type> instead - of <type>com::sun::star::awt::XBitmap</type>. + com::sun::star::rendering::XBitmap instead + of com::sun::star::awt::XBitmap. @see createPreview @param xCanvas This canvas is used create a canvas specific bitmap. diff --git a/offapi/com/sun/star/drawing/XSlideSorterBase.idl b/offapi/com/sun/star/drawing/XSlideSorterBase.idl index 339a0f0c3dae..08efe55f1047 100644 --- a/offapi/com/sun/star/drawing/XSlideSorterBase.idl +++ b/offapi/com/sun/star/drawing/XSlideSorterBase.idl @@ -32,17 +32,17 @@ module com { module sun { module star { module drawing { /** This interface exists only because services do not directly support multiple inheritance and attributes. <p>It provides the interfaces and attributes that every object that - implements the <type>SlideSorter</type> service.</p> + implements the SlideSorter service.</p> */ interface XSlideSorterBase { - /** This interface is included to mark a <type>SlideSorter</type> object + /** This interface is included to mark a SlideSorter object as view of the drawing framework and to provide a - <type>ResourceId</type>. + ResourceId. */ interface ::com::sun::star::drawing::framework::XView; - /** The <type>XDrawView</type> interface is included to provide access + /** The XDrawView interface is included to provide access to the current slide (especially write access). */ interface ::com::sun::star::drawing::XDrawView; diff --git a/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl b/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl index 4ef84a8d9259..97ff237c8cca 100644 --- a/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module drawing { module framework { <code>private:resource/floater/CenterPane</code> and <code>private:resource/floater/RightPane</code> respectively.</p> <p>This factory is typically created indirectly by registering it in the - configuration and have the <type>XModuleController</type> create it on + configuration and have the XModuleController create it on demand.</p> */ service BasicPaneFactory : XResourceFactory diff --git a/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl b/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl index b028c2ebd247..55e1d5004b53 100644 --- a/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { module framework { -/** The <type>BasicToolBarFactory</type> is a resource factory that provides +/** The BasicToolBarFactory is a resource factory that provides (some of) the tool bars used by the Draw and Impress applications. <p>The factory recognizes the following URLs:<ul> @@ -37,7 +37,7 @@ module com { module sun { module star { module drawing { module framework { </p> <p>This factory is typically created indirectly by registering it in the - configuration and have the <type>XModuleController</type> create it on + configuration and have the XModuleController create it on demand.</p> */ service BasicToolBarFactory : XResourceFactory diff --git a/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl b/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl index a41544fe2f6e..84f59a810e8e 100644 --- a/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { module framework { -/** The <type>BasicViewFactory</type> is a view factory that provides the +/** The BasicViewFactory is a view factory that provides the panes used by the Draw and Impress applications. <p>The factory recognizes the following URLs:<ul> diff --git a/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl b/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl index 1c81a708e5e1..f32a5f3cc030 100644 --- a/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl +++ b/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl @@ -39,7 +39,7 @@ interface XResourceId; <p>The set of used members and the exact meaning of their values is not the same for all types. Therefore, the descriptions of the members are just - general guidelines. See <type>XConfigurationController</type> for a + general guidelines. See XConfigurationController for a list of event types used by the basic drawing framework.</p> */ struct ConfigurationChangeEvent diff --git a/offapi/com/sun/star/drawing/framework/ConfigurationController.idl b/offapi/com/sun/star/drawing/framework/ConfigurationController.idl index 594062087f81..5d676ada0720 100644 --- a/offapi/com/sun/star/drawing/framework/ConfigurationController.idl +++ b/offapi/com/sun/star/drawing/framework/ConfigurationController.idl @@ -26,11 +26,11 @@ module com { module sun { module star { module drawing { module framework { -/** See <type>XConfigurationController</type> for a description of the +/** See XConfigurationController for a description of the configuration controller. <p>This service is used at the moment by the - <type>XControllerManager</type> to create a configuration controller. + XControllerManager to create a configuration controller. This allows developers to replace the default implementation of the configuration controller with their own. This may not be a useful feature. Furthermore the sub controllers may need a tighter coupling diff --git a/offapi/com/sun/star/drawing/framework/ModuleController.idl b/offapi/com/sun/star/drawing/framework/ModuleController.idl index a810ecabf6d6..493b284e2422 100644 --- a/offapi/com/sun/star/drawing/framework/ModuleController.idl +++ b/offapi/com/sun/star/drawing/framework/ModuleController.idl @@ -25,19 +25,19 @@ module com { module sun { module star { module drawing { module framework { -/** See <type>XModuleController</type> for a description of the module +/** See XModuleController for a description of the module controller. - <p>See <type>ConfigurationController</type> for a comment why this + <p>See ConfigurationController for a comment why this service may be removed in the future.</p> - <p>The <type>ModuleController</type> object for an application can be - obtained via the <type>XControllerManager</type> interface.</type> + <p>The ModuleController object for an application can be + obtained via the XControllerManager interface.</type> */ service ModuleController : XModuleController { - /** Create a new instance of a <type>ModuleController</type> as sub - controller of the given <type>XController</type> object. + /** Create a new instance of a ModuleController as sub + controller of the given XController object. */ create ([in] ::com::sun::star::frame::XController xController); }; diff --git a/offapi/com/sun/star/drawing/framework/ResourceId.idl b/offapi/com/sun/star/drawing/framework/ResourceId.idl index 6b5f7ddd9ee1..8a70d4515d0a 100644 --- a/offapi/com/sun/star/drawing/framework/ResourceId.idl +++ b/offapi/com/sun/star/drawing/framework/ResourceId.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { module framework { -/** The <type>ResourceId</type> service provides several constructors for +/** The ResourceId service provides several constructors for resource ids. <p>They mainly differ in how the anchor is specified.</p> */ @@ -42,7 +42,7 @@ service ResourceId create ([in] string sResourceURL); /** Create a resource id for an anchor that is given as - <type>XResourceId</type> object. This is the most general of the + XResourceId object. This is the most general of the constructor variants. */ createWithAnchor ([in] string sResourceURL, [in] XResourceId xAnchor); diff --git a/offapi/com/sun/star/drawing/framework/TabBarButton.idl b/offapi/com/sun/star/drawing/framework/TabBarButton.idl index 7654d99bf23d..769296496737 100644 --- a/offapi/com/sun/star/drawing/framework/TabBarButton.idl +++ b/offapi/com/sun/star/drawing/framework/TabBarButton.idl @@ -28,7 +28,7 @@ interface XResourceId; offer the user the choice between different views to be displayed in one pane. <p>For identification only the <member>ResourceId</member> is used, so for - some methods of the <type>XTabBar</type> interface only the + some methods of the XTabBar interface only the <member>ResourceId</member> member is evaluated.</p> */ struct TabBarButton @@ -42,9 +42,9 @@ struct TabBarButton */ string HelpText; - /** <type>XResourceId</type> object of the resource that is requested to be + /** XResourceId object of the resource that is requested to be displayed when the tab bar button is activated. - <p>For some methods of the <type>XTabBar</type> interface only this + <p>For some methods of the XTabBar interface only this member is evaluated. That is because only this member is used to identify a tab bar button.</p> */ diff --git a/offapi/com/sun/star/drawing/framework/XConfiguration.idl b/offapi/com/sun/star/drawing/framework/XConfiguration.idl index 89b577d9e388..b45c03449053 100644 --- a/offapi/com/sun/star/drawing/framework/XConfiguration.idl +++ b/offapi/com/sun/star/drawing/framework/XConfiguration.idl @@ -35,8 +35,8 @@ interface XResourceId; configuration but also a requested configuration can be represented. <p>Direct manipulation of a configuration object is not advised with the - exception of the <type>ConfigurationController</type> and objects that - implement the <type>XConfigurationChangeRequest</type> interface.</p> + exception of the ConfigurationController and objects that + implement the XConfigurationChangeRequest interface.</p> @see XConfigurationController */ @@ -48,8 +48,8 @@ interface XConfiguration returned resource ids. @param xAnchorId This anchor typically is either a pane or an empty - <type>XResourceId</type> object. An - empty reference is treated like an <type>XResourceId</type> object. + XResourceId object. An + empty reference is treated like an XResourceId object. @param sURLPrefix When a non-empty string is given then resource ids are returned only when their resource URL matches this prefix, i.e. when it @@ -82,7 +82,7 @@ interface XConfiguration active, i.e. has a visible representation in the GUI. @param xResourceId The id of a resource. May be empty (empty reference or empty - <type>XResourceId</type> object) in which case <FALSE/> is + XResourceId object) in which case <FALSE/> is returned. @return Returns <TRUE/> when the resource is part of the configuration @@ -92,7 +92,7 @@ interface XConfiguration /** Add a resource to the configuration. <p>This method should be used only by objects that implement the - <type>XConfigurationRequest</type> interface or by the configuration + XConfigurationRequest interface or by the configuration controller.</p> @param xResourceId The resource to add to the configuration. When the specified @@ -106,7 +106,7 @@ interface XConfiguration /** Remove a resource from the configuration. <p>This method should be used only by objects that implement the - <type>XConfigurationRequest</type> interface or by the configuration + XConfigurationRequest interface or by the configuration controller.</p> @param xResourceId The resource to remove from the configuration. When the diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl index bc8d976843db..fa371428647d 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl @@ -33,13 +33,13 @@ interface XConfiguration; <member>execute()</member> method is called. Configuration change requests are executed asynchronously. This is done to avoid reentrance problems with objects that are registered as - <type>XConfigurationChangeListener</type> and at the same time make + XConfigurationChangeListener and at the same time make configuration change requests. When the requests were executed synchronously then the listeners would be notified of the changes while their request call has not yet returned.</p> <p>This interface is typically used internally by the - <type>XConfigurationController</type></p> @see XConfigurationController + XConfigurationController</p> @see XConfigurationController */ interface XConfigurationChangeRequest { diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl index 13135d796e52..edd1efbd452b 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl @@ -63,12 +63,12 @@ interface XResource; <member>requestResourceActivation()</member> or <member>requestResourceDeactivation()</member> results in one or more function objects, that each implement the - <type>XConfigurationChangeRequest</type> interface. These are inserted + XConfigurationChangeRequest interface. These are inserted into a queue. The request objects in the queue are processed asynchronously one at a time in the order in which they are inserted. Only when one request object is processed a change to the requested configuration is made. These changes are broadcasted to registered - <type>XConfigurationChangeListener</type> objects. Listeners may + XConfigurationChangeListener objects. Listeners may decide to make requests that then are added to the queue. For example when the view in the center pane is replaced by another view, some listeners may want to turn some side panes on or off, or show other @@ -129,13 +129,13 @@ interface XResource; activated, i.e. when a new object of a resource is created (or taken from a cash).</p> <p>The <member>ResourceId</member> and <member>ResourceObject</member> - members are set to the <type>XResourceId</type> and object reference of + members are set to the XResourceId and object reference of the activated resource.</p></li> <li><const>ResourceDeactivation</const> is sent when a resource is deactivated, i.e. when an object that previously was part of the configuration is removed from the configuration.</p> <p>The <member>ResourceId</member> and <member>ResourceObject</member> - members are set to <type>XResourceId</type> and object reference of the + members are set to XResourceId and object reference of the deactivated resource.</p></li> </ul></p> */ diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl index 3c6d5831bde4..26f59084057b 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl @@ -32,7 +32,7 @@ interface XConfigurationChangeRequest; <p>This interface allows callers to add requests to the back of the queue and to determine whether the queue is empty. Using this interface should normally not be necessary for anyone else than the - <type>XConfigurationController</type>. It may be removed in the future.</p> + XConfigurationController. It may be removed in the future.</p> */ interface XConfigurationControllerRequestQueue { diff --git a/offapi/com/sun/star/drawing/framework/XControllerManager.idl b/offapi/com/sun/star/drawing/framework/XControllerManager.idl index 0a7f4e66a99c..d6530788df3c 100644 --- a/offapi/com/sun/star/drawing/framework/XControllerManager.idl +++ b/offapi/com/sun/star/drawing/framework/XControllerManager.idl @@ -29,19 +29,19 @@ interface XModuleController; /** The XControllerManager gives access to the controllers of the drawing framework. - <p>The <type>XControllerManager</type> interface is typically + <p>The XControllerManager interface is typically implemented by the same object that implements <type scope="com::sun::star::frame">XController</type>.</p> */ interface XControllerManager { - /** Return the <type>XConfigurationController</type> object. + /** Return the XConfigurationController object. @return The returned reference is never empty. */ XConfigurationController getConfigurationController (); - /** Return the <type>XModuleController</type> object. + /** Return the XModuleController object. @return The returned reference is never empty. */ diff --git a/offapi/com/sun/star/drawing/framework/XResource.idl b/offapi/com/sun/star/drawing/framework/XResource.idl index 6d924c4f56a5..0620bc49c5f1 100644 --- a/offapi/com/sun/star/drawing/framework/XResource.idl +++ b/offapi/com/sun/star/drawing/framework/XResource.idl @@ -31,7 +31,7 @@ interface XResourceId; */ interface XResource { - /** Return an <type>XResourceId</type> object for the called resource. + /** Return an XResourceId object for the called resource. The returned id unambiguously identifies the resource. */ XResourceId getResourceId (); diff --git a/offapi/com/sun/star/drawing/framework/XResourceFactory.idl b/offapi/com/sun/star/drawing/framework/XResourceFactory.idl index 086b70bfa093..0c7c270de692 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceFactory.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceFactory.idl @@ -31,13 +31,13 @@ interface XResourceId; /** Factory and possibly cache for creating and releasing resources. <p>A resource factory is created and used by the - <type>XConfigurationController</type> object.</p> + XConfigurationController object.</p> <p>A factory may want to implement a cache to reuse previously released resources.</p> */ interface XResourceFactory { - /** Create a resource for the given <type>XResourceId</type> object. + /** Create a resource for the given XResourceId object. @param xResourceId The resource URL of this id specifies the type of resource to create. The anchor can be used to obtain the associated object @@ -45,7 +45,7 @@ interface XResourceFactory created, then the new object can be initialized with the pane that is its anchor. <p>Valid values are those for which the factory has previously been - registered at the <type>XConfigurationController</type></p>. + registered at the XConfigurationController</p>. @return Returns a resource object that has been just created or was taken from a cache. When the requested resource can not be diff --git a/offapi/com/sun/star/drawing/framework/XResourceId.idl b/offapi/com/sun/star/drawing/framework/XResourceId.idl index 87b5df2a891b..5a9be782fd2e 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceId.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceId.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module drawing { module framework { views), or it is empty (for panes).</p> <p>The resource URL may be empty. In this case the anchor is empty, too. Such an empty resource id does not describe a resource but rather - the absence of one. Instead of an empty <type>XResourceId</type> object + the absence of one. Instead of an empty XResourceId object an empty reference can be used in many places.</p> <p>The resource URL may have arguments that are passed to the factory method on its creation. Arguments are only available through the @@ -73,7 +73,7 @@ interface XResourceId */ string getResourceTypePrefix (); - /** Compare the called <type>XResourceId</type> object with the given + /** Compare the called XResourceId object with the given one. <p>The two resource ids A and B are compared so that if A<B (return value is -1) then either A and B are unrelated or A is a direct or |