summaryrefslogtreecommitdiff
path: root/codemaker
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /codemaker
parent33da78c21f4243a3e469fb7df79ed1745df70078 (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 'codemaker')
-rw-r--r--codemaker/README.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/codemaker/README.md b/codemaker/README.md
index 436086cec5e5..c195112fde69 100644
--- a/codemaker/README.md
+++ b/codemaker/README.md
@@ -1,17 +1,19 @@
+# Language Code Generators for UNOIDL Entities
+
Generators for language-binding--specific representations of UNOIDL entities:
-- cppumaker generates header (.hdl and .hpp) files for the C++ UNO language
- binding
-- javamaker generates class files for the JVM language binding
-- the codemaker for .Net is in module cli_ure
-Some of the code is re-used by the skeletonmakers in module unodevtools.
+- `cppumaker` generates header (`.hdl` and `.hpp`) files for the C++ UNO language
+ binding
+- `javamaker` generates class files for the JVM language binding
+- the codemaker for .NET is in module `cli_ure`
+Some of the code is re-used by the skeletonmakers in module `unodevtools`.
Note the different terminology used by cppumaker vs. gbuild for the three
variants that can be generated by cppumaker for some of the inline functions:
- cppumaker switch: -L; cpputype.cxx: light; gbuild: normal;
- cppumaker switch: none; cpputype.cxx: normal; gbuild: bootstrap;
- cppumaker switch: -C; cpputype.cxx: comprehensive; gbuild: comprehensive;
+ cppumaker switch: -L; cpputype.cxx: light; gbuild: normal;
+ cppumaker switch: none; cpputype.cxx: normal; gbuild: bootstrap;
+ cppumaker switch: -C; cpputype.cxx: comprehensive; gbuild: comprehensive;
-...a recipe for confusion.
+which can be a source of confusion.