La documentation IDL, fournie par le SDK, décrit les différents services, interfaces, propriétés, etc, de l'API.
Depuis la version 4.2 de LibreOffice cette documentation a une présentation très différente de celle employée par Apache OpenOffice et OpenOffice.org. Les fichiers html de documentation sont générés par un outil général de développeur,
doxygen, au lieu de
autodoc, qui est adapté aux concepts de l'API OpenOffice.
La documentation IDL de LibreOffice répartit les éléments en Namespaces et Classes, notions utiles pour étudier la structure du logiciel, mais sans intérêt pour un utilisateur de l'API.
Pour trouver la documentation d'un élément inconnu on utilise les indexes.
Apache OpenOffice regroupe tous les éléments de l'API dans un seul index alphabétique, une page par lettre initiale, exemple
page des A; chaque ligne de l'index indique l'adresse hiérarchique et le type de l'entité correspondante, ce qui permet de distinguer les entités ayant le même nom.
LibreOffice présente plusieurs indexes alphabétiques; certains tiennent sur une seule page, d'autres ont une page par lettre initiale.
En cas d'homonymie l'index donne une liste de liens, parfois sans préciser leur hiérarchie dans l'API. Il faut lire la page de chaque lien pour comprendre à quoi chacun correspond.
Chaque index liste les entités d'un ou plusieurs types. Les noms de ces types peuvent différer des concepts API et prêter à confusion.
- Namespace Members
- Class Members
- Functions = API function
- Variables = API attribute, property, field in struct, field in exception, sequence
- All = regroupement des entités ci-dessus
- Class Index
Sur une seule page Web, cet index liste les entités des autres types de l'API : service, interface, structure...
Le nom du lien indique sa hiérarchie dans l'API.
Les pages descriptives diffèrent elles aussi de la documentation Apache OpenOffice. L'adresse de ces pages ne reflète pas la hiérarchie API. La hiérarchie est indiquée en haut de page, dans la troisième ligne bleutée.
Les termes employés dans les titres de section prêtent à confusion: Member, Attributes.
- Dans une page de service l'accent est mis sur l'héritage des services et des interfaces. Sous Public Attributes on trouve essentiellement des propriétés. Exemple service com.sun.star.text.textfield.docinfo.Revision : LibreOffice / Apache OpenOffice
- Dans une page d'interface, dans la section Public Attributes on trouve les attributs de l'interface. Exemple interface com.sun.star.presentation.XSlideShowController : LibreOffice / Apache OpenOffice