commit 3309c339b20aaeb29157576a620c4f38ee98730c
author Jan Eilers <jan.eilers@arm.com> Tue Aug 17 13:50:08 2021 +0100
committer Nikhil Raj <nikhil.raj@arm.com> Fri Aug 20 11:14:02 2021 +0100
tree bb118acb596a6b3366f4acb9968ebb3f5bf4fb2d
parent 4914d0c1f4cbb01fe276a7093af4cff13270b74a

Make samples visible in doxygen

 * uses the @example doxygen command to add all our simple examples
   into an 'Examples' tab in the doxygen documentation

Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: Ie8ae19ca471a0616eeea7f708d547388c8ee860e
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>

docs/Doxyfile

diff --git a/docs/Doxyfile b/docs/Doxyfile
index 1651004..3fc872e 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -840,7 +840,8 @@
                          ./InstallationViaAptRepository.md \
                          ./ContributorGuide.md \
                          ./BuildGuideAndroidNDK.md \
-                         ./BuildGuideCrossCompilation.md
+                         ./BuildGuideCrossCompilation.md \
+                         ./samples/examples.dox
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses