office-gobmx/odk
Stephan Bergmann dcded5774c Drop poor @attention paragraph
For one, Javadoc (unlike Doxygen) doesn't support @attention, so this caused a

> Generating workdir/CustomTarget/odk/docs/java/ref/help-doc.html...
> Note: Custom tags that could override future standard tags:  @attention. To avoid potential overrides, use at least one period character (.) in custom tag names.
> Note: Custom tags that were not seen:  @attention

warning during the build.  And for another, that paragraph was phrased in poor,
broken English and didn't add much value anyway.

Change-Id: I603170ec262d042e92bdff38ae415dda0bcc28bb
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/137053
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-07-14 14:03:35 +02:00
..
config
docs
examples
qa/checkapi
settings
source
util
build-examples_common.mk
CppunitTest_odk_checkapi.mk
CustomTarget_allheaders.mk
CustomTarget_build-examples.mk
CustomTarget_build-examples_java.mk
CustomTarget_check.mk
CustomTarget_classes.mk
CustomTarget_config_win.mk
CustomTarget_doxygen.mk
CustomTarget_html.mk
CustomTarget_javadoc.mk
CustomTarget_settings.mk
Executable_unoapploader.mk
GeneratedPackage_odk_doxygen.mk
GeneratedPackage_odk_javadoc.mk
GeneratedPackage_uno_loader_classes.mk
index.html
index_online.html
Makefile
Module_odk.mk
Package_cli.mk
Package_config.mk
Package_config_win.mk
Package_docs.mk
Package_examples.mk
Package_html.mk
Package_odk_headers.mk
Package_odk_headers_generated.mk
Package_settings.mk
Package_settings_generated.mk
Package_share_readme.mk
Package_share_readme_generated.mk
README.md

Office Development Kit (odk)

Office development kit (odk) - implements the first step on the way to the LibreOffice SDK tarball.

Part of the SDK; to build you need to add --enable-odk.

Testing the Examples:

  • Go to instdir/sdk (Don't try directly in odk/)

  • See https://api.libreoffice.org/docs/install.html how to set up the SDK.

    • When asked about it during configuration, tell the SDK to do automatic deployment of the example extensions that get built.
  • In a shell set up for SDK development, build (calling make) and test (following the instructions given at the end of each make invocation) each of the SDK's examples/ sub-directories.

    • An example script to build (though not test) the various examples in batch mode is

      find examples \( -type d -name nativelib -prune \) -o \ \( -name Makefile -a -print -a \( -execdir make \; -o -quit \) \)

      (Note that one of the example extensions asks you to accept an example license on stdin during deployment.)