aboutsummaryrefslogtreecommitdiff
path: root/doxygen
AgeCommit message (Collapse)Author
2019-03-05Doc: fix doxygen comments.Gyorgy Szing
Some existing doxygen comments resulted in bad or bad looking documentation. These were fixed. Change-Id: I20ab5a81c54d3bdc0e056965ad7de293d472cdf9 Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
2019-03-05Doc: non C specific doxygen documentation added.Gyorgy Szing
Some parts of the TF-M Reference Manual are defined/written outside of C source files. These files have the .dox extension and have meta-data in C coments and doxygen documentation in C doxygen comments. Change-Id: Ia348be72acae9958f1bc65588cc4c14c8cf0c7e7 Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
2019-03-05Doc: added documentation build support.Gyorgy Szing
This change enables checking for availability of tools needed to build the doxygen documentation (Reference Manual), and building the manual. During the configuration phase CMake will search for doxygen, PlanUML, dot, java and Latex tools. Then it will "configure" the file doxygen/Doxyfile.in, and generate the following targets: - doc_refman: to build HTML documentation - doc_refman_pdf: to build PDF documentation - install_doc: to install all build documentation files If any mandatory tool is missing, CMake will issue a warning and not generate the targets. Thus missing tools will not stop the user to build the firmware, just remove the documentation build capability. PDF generation is optional, if latex is missing, HTML documentation can still be generated. Change was tested on: -Win10 with native windows doxygen and MixTex for PDF generation. -Linux Mint 18.1 Serena (based on Ubuntu 16.04 - Xenial Xerus) Change-Id: I25fb80bb8eee8e510c9bd55bffb5974d2360651f Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>