diff options
author | Steven Moreland <smoreland@google.com> | 2018-05-17 15:45:26 -0700 |
---|---|---|
committer | Steven Moreland <smoreland@google.com> | 2018-05-18 14:59:31 -0700 |
commit | 49bad8df77e1fe1ca3c06fe49790a6e3304e7249 (patch) | |
tree | 984fd4c068586b9c0d907789b1684bc4313e4caf /Reference.h | |
parent | 88799afc0c130ebaadbd17d14b6824f5168fd97c (diff) | |
download | android_system_tools_hidl-49bad8df77e1fe1ca3c06fe49790a6e3304e7249.tar.gz android_system_tools_hidl-49bad8df77e1fe1ca3c06fe49790a6e3304e7249.tar.bz2 android_system_tools_hidl-49bad8df77e1fe1ca3c06fe49790a6e3304e7249.zip |
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
Diffstat (limited to 'Reference.h')
-rw-r--r-- | Reference.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Reference.h b/Reference.h index 4b03c15..7ddc889 100644 --- a/Reference.h +++ b/Reference.h @@ -21,6 +21,7 @@ #include <android-base/logging.h> #include <hidl-util/FQName.h> +#include "DocComment.h" #include "Location.h" namespace android { @@ -120,7 +121,7 @@ struct Reference { }; template <class T> -struct NamedReference : public Reference<T> { +struct NamedReference : public Reference<T>, DocCommentable { NamedReference(const std::string& name, const Reference<T>& reference, const Location& location) : Reference<T>(reference, location), mName(name) {} |