commit | 49bad8df77e1fe1ca3c06fe49790a6e3304e7249 | [log] [tgz] |
---|---|---|
author | Steven Moreland <smoreland@google.com> | Thu May 17 15:45:26 2018 -0700 |
committer | Steven Moreland <smoreland@google.com> | Fri May 18 14:59:31 2018 -0700 |
tree | 984fd4c068586b9c0d907789b1684bc4313e4caf | |
parent | 88799afc0c130ebaadbd17d14b6824f5168fd97c [diff] |
hidl-gen: understand doc comments Doc comments were used by hidl-doc in order to generate documentation. However, because hidl-doc tokenizes the entire file including the comments some of the information is lost. Rather than refactor hidl-doc, we are going to use 3rd party doc generation tools in order to generate docs from the output of hidl-gen. This has a couple of benefits: - people automatically get the documentation if they are using an IDE which pulls the documentation - hidl-doc/hidl-gen won't get out of sync - documentation will be closer to actual usage This will require ABI-safe changes to some HAL interfaces. Bug: 78135149 Test: manually inspect hidl-gen output. Test: (sanity) run_all_host_tests.sh Test: (sanity) run_all_device_tests.sh Change-Id: I9a09ed48e2e3834fab7e032e29c48f466510e51f
croot make hidl-gen
hidl-gen -o output-path -L language (-r interface-root) fqname output-path: directory to store the output files. language: output file for given language. e.g.c++, vts.. fqname: fully qualified name of the input files. For singe file input, follow the format: package@version::fileName For directory input, follow the format: package@version interface-root(optional): prefix and root path for fqname. If not set, use the default prefix: android.hardware and default root path defined in $TOP. examples: croot hidl-gen -o output -L c++ -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport android.hardware.nfc@1.0::INfc.hal hidl-gen -o output -L vts -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport android.hardware.nfc@1.0 hidl-gen -o test -L c++ -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport android.hardware.nfc@1.0 hidl-gen -L hash -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport android.hardware.nfc@1.0