summaryrefslogtreecommitdiffstats
path: root/offapi/README.md
blob: 1d35bd2ca51a3787d67432e52fa627943648de83 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# LibreOffice API IDL Files Except UDK API

Contains all of the IDL files except those in `udkapi`.

i.e. the interfaces that are specific to the LibreOffice application.
An artificial (?) separation.

The reference `offapi/type_reference/offapi.idl` and
`udkapi/type_reference/udkapi.idl` (formerly combined into a single
`offapi/type_reference/types.rdb`) are used to detect inadvertent incompatible
changes.  They are plain-text `.idl` files (not strictly lexicographically sorted,
though, so they satisfy the `.idl` file requirements for no forward dependencies),
so in cases where we deliberately /do/ become incompatible they can be modified
manually.

Old such cases of deliberately becoming incompatible are listed in
`offapi/type_reference/typelibrary_history.txt`, newer such cases are recorded in
the `git log`s of (now superseded) `offapi/type_reference/types.rdb`,
`offapi/type_reference/offapi.rdb`, and `udkapi/type_reference/udkapi.rdb`, new such
cases are recorded in the `git log`s of `offapi/type_reference/offapi.idl` and
`udkapi/type_reference/udkapi.idl`.