diff options
| author | Hossein <hossein.ir@gmail.com> | 2021-03-29 21:55:26 +0430 |
|---|---|---|
| committer | Adolfo Jayme Barrientos <fitojb@ubuntu.com> | 2021-04-07 17:47:16 +0200 |
| commit | ea5641baeef73af60d025d185901a303844e2d85 (patch) | |
| tree | 94b343b35e7b8805beb9a1745fe1de2f382574fb /offapi | |
| parent | 33da78c21f4243a3e469fb7df79ed1745df70078 (diff) | |
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md
and now, the contents of these files were changed to use Markdown
format. Other than format inconsistency, some README.md files lacked
information about modules, or were out of date. By using LibreOffice
/ OpenOffice wiki and other documentation websites, these files were
updated. Now every README.md file has a title, and some description.
The top-level README.md file is changed to add links to the modules.
The result of processing the Markdown format README.md files can be
seen at: https://docs.libreoffice.org/
Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'offapi')
| -rw-r--r-- | offapi/README.md | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/offapi/README.md b/offapi/README.md index 80c60484d1c7..1d35bd2ca51a 100644 --- a/offapi/README.md +++ b/offapi/README.md @@ -1,19 +1,21 @@ -Contains all of the IDL files except those in [[udkapi]] +# 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), +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 logs 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 logs of offapi/type_reference/offapi.idl and -udkapi/type_reference/udkapi.idl. +`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`. |