commit | d4dd93dde171667f78289ae2e8b638601da0a764 | [log] [tgz] |
---|---|---|
author | Steven Moreland <smoreland@google.com> | Tue May 22 18:10:09 2018 -0700 |
committer | Steven Moreland <smoreland@google.com> | Fri Nov 30 00:03:50 2018 +0000 |
tree | bef6d3fd61184b7aed5f6d67f614b449ae98ba4d | |
parent | e5faf7ec83b4dddaee9df4886d198b246f58b82d [diff] |
helper scripts to generate source for doc generation e.x.: source build/make/envsetup.sh lunch aosp_arm64-userdebug # doesn't matter what this is, so this works m hidl-gen mkdir ~/hidl-doc-workspace cd ~/hidl-doc-workspace source $ANDROID_BUILD_TOP/system/tools/hidl/scripts/gen-docs.sh hidl-doc-generate-sources Then: ~/hidl-doc-workspace/gen/java -> all released HALs' java sources which need to be turned into documentation (if they support generating java) ~/hidl-doc-workspace/gen/cpp -> all released HALs' cpp sources which need to be turned into documentation Another tool will be used to invoke doxygen on these files for the dev site. Bug: 78135149 Test: the above steps Change-Id: Ieaac752b4e2b21e6b8c2d1fff45284e6323246c8
Full documentation can be found here: https://source.android.com/devices/architecture/hidl/
hidl-gen is a compiler for the HIDL (HAL Interface Design Language) which generates C++ and Java endpoints for RPC mechanisms. The main userspace libraries which this compiler uses can be found at system/libhidl.
m hidl-gen
Note that options for hidl-gen expected to be invoked by the build system are marked with 'internal' in the help menu.
hidl-gen -h hidl-gen -o output -L c++-impl -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport android.hardware.nfc@1.0
Some defaults for package roots are also provided
hidl-gen -o output -L c++-impl android.hardware.nfc@1.0 hidl-gen -o output -L vts android.hardware.nfc@1.0 hidl-gen -L hash android.hardware.nfc@1.0
Example command for vendor project
hidl-gen -L c++-impl -r vendor.foo:vendor/foo/interfaces vendor.foo.nfc@1.0
See update-makefiles-helper.sh and update-all-google-makefiles.sh for examples of how to generate HIDL makefiles (using the -Landroidbp option).
This is a helper tool to convert C headers to valid .hal files.
m c2hal && c2hal -h
This tool generates html documentation for hal interfaces.
m hidl-doc && hidl-doc -h