diff options
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/README b/docs/README new file mode 100644 index 00000000..e60609fe --- /dev/null +++ b/docs/README @@ -0,0 +1,9 @@ +The Documentation for AMB is generated using Doxygen from amb.fidl. +To enable doxygen generation of documents, pass -Denable_docs=ON to cmake: + +cmake -Denable_docs=ON .. + +The internal AMB class and interface documentation is generated in the docs/amb folder. +DBus API documentation is generated in the docs/dbus folder. + +Specific plugin documentation can be found in the plugins/${plugin}/README (ie plugins/dbus/README). |