diff options
author | Martin Koch <mkoch@de.adit-jv.com> | 2019-10-16 16:22:46 +0200 |
---|---|---|
committer | Martin Koch <mkoch@de.adit-jv.com> | 2019-10-16 16:22:46 +0200 |
commit | 0c2e2cae681cb29ccbd1086458dde75b2141a8b3 (patch) | |
tree | a2910811cf83c7e265c503a08b3beb7f94cdbbd9 /include | |
parent | c18c72c1a4c2bf380257253401b01d63832ddc6f (diff) | |
download | audiomanager-0c2e2cae681cb29ccbd1086458dde75b2141a8b3.tar.gz |
add a documentation to the global namespace 'am'
- the presence of this documentation enables doxygen (as of version 1.8.11) to resolve \ref links
not only for classes, but also for documented enums, typedefs and defines.
Diffstat (limited to 'include')
-rwxr-xr-x | include/audiomanagertypes.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/audiomanagertypes.h b/include/audiomanagertypes.h index 8651185..99e01e2 100755 --- a/include/audiomanagertypes.h +++ b/include/audiomanagertypes.h @@ -37,6 +37,9 @@ #endif
+/**
+ * Container to host all types and classes related to the GenIVI Audio-Manager
+ */
namespace am {
/**
|