TF-A doesn't currently employ any source-level documentation tool so the documentation style varies across the code-base and we don't enforce any particular style. Doxygen is something that we might want to consider - particularly because it can be integrated directly into the existing Sphinx documentation via Breathe (https://breathe.readthedocs.io/en/latest/) - but I think we could only reasonably enforce it for new code.

From: Michal Simek via TF-A <tf-a@lists.trustedfirmware.org>
Sent: 03 April 2023 12:37
To: tf-a@lists.trustedfirmware.org <tf-a@lists.trustedfirmware.org>; Joanna Farley <Joanna.Farley@arm.com>
Subject: [TF-A] TF-A code documentation

Hi,

I have talked to a couple of people to figure out what TF-A project is
using for code documentation. Because I see at least in our platform
that our documentation is somewhere between doxygen and kernel-doc but
actually with a lot of mismatches.
Sanbrine mentioned sending an email to the mailing list to start to
have discussion about it.

That's why I want to know the official code documentation format and
how we should be checking that everything matches to make sure that
documentation is not out of sync from code itself.
When this is clear I will ask my team to fix all these issues.

Thanks,
Michal
--
Michal Simek, Ing. (M.Eng), OpenPGP -> KeyID: FE3D1F91
w: www.monstr.eu p: +42-0-721842854
Maintainer of Linux kernel - Xilinx Microblaze
Maintainer of Linux kernel - Xilinx Zynq ARM and ZynqMP ARM64 SoCs
U-Boot custodian - Xilinx Microblaze/Zynq/ZynqMP/Versal SoCs
--
TF-A mailing list -- tf-a@lists.trustedfirmware.org
To unsubscribe send an email to tf-a-leave@lists.trustedfirmware.org