Bug 157511 - Wrong link in Text of GluePointLeavingDirections and GluePointType
Summary: Wrong link in Text of GluePointLeavingDirections and GluePointType
Status: NEW
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: sdk (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-09-29 12:27 UTC by Regina Henschel
Modified: 2023-10-13 15:13 UTC (History)
3 users (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Regina Henschel 2023-09-29 12:27:38 UTC
In EnhancedCustomShapePath Service Reference [1] in part Public Types you find:
typedef sequence< double > 	GluePointLeavingDirections
 	This property specifies GluePoint leaving directions.

"GluePoint" is a link to GluePoint Struct Reference [2]. That is wrong in content. That "GluePoint" belongs to those, which can be set in the UI. Whereas the GluePointLeavingDirections belongs to those glue points, which are defined in the enhanced custom shape geometry. That are those in the item above:
typedef sequence<::com::sun::star::drawing::EnhancedCustomShapeParameterPair > 	GluePoints
 	This property specifies custom gluepoints.

Proposal:
Instead of
    This property specifies GluePoint leaving directions.
use
    This property specifies leaving directions for the GluePoints.
Notice the plural s.
There should be no link at all, because the item "GluePoints" is just above the item "GluePointLeavingDirections".

The same wrong link is in [1] for GluePointType:
short 	GluePointType
 	This property defines the GluePoint type.
and its long description.

Proposal:
Instead of
    This property defines the GluePoint type.
use
    This property defines automatically created glue points of an enhanced custom shape geometry.

And in the long description
Instead of
    This property defines the GluePoint type. The values that can be used are specified in com::sun::star::drawing::EnhancedCustomShapeGluePointType
use
    This property defines that glue points are automatically generated. It is ignored in case the member GluePoints exists. The values that can be used are specified in com::sun::star::drawing::EnhancedCustomShapeGluePointType.


These all belong to the ODF attributes "draw:glue-point-leaving-directions", "draw:glue-points" and "draw:glue-point-type" of the <draw:enhanced-geometry> element [3].


[1] https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1drawing_1_1EnhancedCustomShapePath.html#a8a8363cd08ab2fef5c5bdffd58df99c4
[2] https://api.libreoffice.org/docs/idl/ref/structcom_1_1sun_1_1star_1_1drawing_1_1GluePoint.html
[3] https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part3-schema/OpenDocument-v1.3-os-part3-schema.html#element-draw_enhanced-geometry
Comment 1 Julien Nabet 2023-09-29 20:20:01 UTC
If I remember well api is generated from structured comments in idl files, so here's the code pointer:
61 /** This property defines the GluePoint type. The values that can be used are
62     specified in com::sun::star::drawing::EnhancedCustomShapeGluePointType
63 */
64 [optional, property] short GluePointType;
(see https://opengrok.libreoffice.org/xref/core/offapi/com/sun/star/drawing/EnhancedCustomShapePath.idl?r=5687eba4#61)

Like this since:
commit e0a4d1497d733c4d50f6f6e60a0db0cf20b4a99a
Date:   Tue Mar 1 17:09:45 2005 +0000
INTEGRATION: CWS removedrafts (1.1.2); FILE ADDED
2005/02/14 17:16:53 sj 1.1.2.1: #i42561# remove UNOIDL types from drafts
Comment 2 Stéphane Guillou (stragu) 2023-10-13 13:40:33 UTC
Thank you both.
Olivier, I assume a beginner easyHack?
Comment 3 Olivier Hallot 2023-10-13 15:13:05 UTC
Yes. Can be done directly in gerrit (all pointer already listed).