https://bugs.documentfoundation.org/show_bug.cgi?id=163746
Bug ID: 163746
Summary: API documentation: "optional", "property" decorations
need to be placed closer to the definition
Product: LibreOffice
Version: unspecified
Hardware: All
OS: All
Status: UNCONFIRMED
Severity: normal
Priority: medium
Component: sdk
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected]
Created attachment 197368
--> https://bugs.documentfoundation.org/attachment.cgi?id=197368&action=edit
Current look of the "optional" decoration
Look at e.g.
https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1drawing_1_1DrawingDocumentDrawView.html#adc47d84dd41ceb0dafa93d47634c2ba4,
which is a documentation for DrawingDocumentDrawView Service, at the place
where its optional XWindow interface is described.
Note that the "optional" decoration is placed at the farthest right of the web
page. If your browser is wide enough, it is easily out of one's attention. This
is one of a few means used in our documentation pages to define the optionality
(the other being the kind of arrows connecting pieces on the graph); and in
fact, it is very poorly discoverable to users. An example: [1].
The better placement is needed, e.g. immediately following the declaration,
where it would be readily visible and discoverable.
There are other decorations possible there, e.g. "property", "readonly", some
of which are also present on that page. All of them need to be more
discoverable, and their far-right-wing position is not optimal.
I hope that this is somehow configurable using CSS or the like?
[1]
https://ask.libreoffice.org/t/attempt-at-steering-one-program-from-another/113376
--
You are receiving this mail because:
You are the assignee for the bug.
