1 # Install 2 3 ~~~ 4 $ m -j hidl-doc 5 ~~~ 6 7 # Usage 8 9 View usage info: 10 11 ~~~ 12 $ ./bin/hidl-doc -h 13 ~~~ 14 15 Parse the audio `types.hal` file in the Android repo and output 16 generated HTML reference to the reference directory. Enable verbose mode: 17 18 ~~~ 19 $ ./bin/hidl-doc -v -i /path/to/android/hardware/interfaces/audio/2.0/types.hal \ 20 -o /path/to/output/en/reference/hidl/ 21 ~~~ 22 23 Parse all HAL files in the Android `/hardware/interfaces/` directory 24 and output generated HTML reference docs to reference directory. Skip files 25 that encounter doc parse errors: 26 27 ~~~ 28 $ ./bin/hidl-doc -v -s -i /path/to/android/hardware/interfaces/ \ 29 -o /path/to/output/en/reference/hidl/ 30 ~~~ 31 # Templates 32 33 HTML templates are used to generate the output docs and are in the 34 `resources/template/` directory. Since these files are bundled up in the fat jar 35 file, if you make any changes to the templates, `hidl-doc.jar` must be rebuilt. 36
