ArmPkg: Document libraries in ArmPkg.dec

This patch documents the libraries advertised in ArmPkg.dec.

Cc: Bret Barkelew <bret.barkelew@microsoft.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>

diff --git a/ArmPkg/ArmPkg.dec b/ArmPkg/ArmPkg.dec
index 496f588bd0ca4a32bf896a559c8a7c5eb0fae3cb..151626039b0c4a442c54245dc3bc8176cc5afda2 100644 (file)
--- a/ArmPkg/ArmPkg.dec
+++ b/ArmPkg/ArmPkg.dec
@@ -27,20 +27,67 @@
   Include                        # Root include for the package\r
 \r
 [LibraryClasses.common]\r
+  ##  @libraryclass  Provides an interface to Arm registers.\r
+  #\r
   ArmLib|Include/Library/ArmLib.h\r
+\r
+  ##  @libraryclass  Provides a Mmu interface.\r
+  #\r
   ArmMmuLib|Include/Library/ArmMmuLib.h\r
+\r
+  ##  @libraryclass  Provides a semihosting interface.\r
+  #\r
   SemihostLib|Include/Library/SemihostLib.h\r
+\r
+  ##  @libraryclass  Provides a default exception handler.\r
+  #\r
   DefaultExceptionHandlerLib|Include/Library/DefaultExceptionHandlerLib.h\r
+\r
+  ##  @libraryclass  Convert Arm instructions to a human readable format.\r
+  #\r
   ArmDisassemblerLib|Include/Library/ArmDisassemblerLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to initialize a\r
+  #   Generic Interrupt Controller (GIC).\r
+  #\r
   ArmGicArchLib|Include/Library/ArmGicArchLib.h\r
+\r
+  ##  @libraryclass  Provides a Mailbox Transport Layer (MTL) interface\r
+  #   for the System Control and Management Interface (SCMI).\r
+  #\r
   ArmMtlLib|Include/Library/ArmMtlLib.h\r
+\r
+  ##  @libraryclass  Provides a SuperVisor Call (SVC) interface.\r
+  #\r
   ArmSvcLib|Include/Library/ArmSvcLib.h\r
+\r
+  ##  @libraryclass  Provides an OpTee interface.\r
+  #\r
   OpteeLib|Include/Library/OpteeLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to a StandaloneMm Mmu.\r
+  #\r
   StandaloneMmMmuLib|Include/Library/StandaloneMmMmuLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to Arm generic counters.\r
+  #\r
   ArmGenericTimerCounterLib|Include/Library/ArmGenericTimerCounterLib.h\r
+\r
+  ##  @libraryclass  Provides a Generic Interrupt Controller (GIC)\r
+  #   configuration interface.\r
   ArmGicLib|Include/Library/ArmGicLib.h\r
+\r
+  ##  @libraryclass  Provides a HyperVisor Call (HVC) interface.\r
+  #\r
   ArmHvcLib|Include/Library/ArmHvcLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to query miscellaneous OEM\r
+  #   information.\r
+  #\r
   OemMiscLib|Include/Library/OemMiscLib.h\r
+\r
+  ##  @libraryclass  Provides a System Monitor Call (SMC) interface.\r
+  #\r
   ArmSmcLib|Include/Library/ArmSmcLib.h\r
 \r
 \r