ArmPlatformPkg: Document libraries in ArmPlatformPkg.dec

This patch documents the libraries advertised in ArmPlatformPkg.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>

diff --git a/ArmPlatformPkg/ArmPlatformPkg.dec b/ArmPlatformPkg/ArmPlatformPkg.dec
index 696d636aaceea9e157e232794a71b71a6d45f94d..3a25ddcdc8cacb692074734aeecb0b6d3708423a 100644 (file)
--- a/ArmPlatformPkg/ArmPlatformPkg.dec
+++ b/ArmPlatformPkg/ArmPlatformPkg.dec
@@ -1,6 +1,6 @@
 #/** @file\r
 #\r
-#  Copyright (c) 2011-2018, ARM Limited. All rights reserved.\r
+#  Copyright (c) 2011-2021, ARM Limited. All rights reserved.\r
 #  Copyright (c) 2015, Intel Corporation. All rights reserved.\r
 #\r
 #  SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -26,11 +26,28 @@
   Include                        # Root include for the package\r
 \r
 [LibraryClasses]\r
+  ##  @libraryclass  Provides an interface to query platform information.\r
+  #\r
   ArmPlatformLib|Include/Library/ArmPlatformLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to initialize/shutdown a LCD screen.\r
+  #\r
   LcdHwLib|Include/Library/LcdHwLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to configure a LCD screen.\r
+  #\r
   LcdPlatformLib|Include/Library/LcdPlatformLib.h\r
+\r
+  ##  @libraryclass  Provides a Nor flash interface.\r
+  #\r
   NorFlashPlatformLib|Include/Library/NorFlashPlatformLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to the clock of a PL011 device.\r
+  #\r
   PL011UartClockLib|Include/Library/PL011UartClockLib.h\r
+\r
+  ##  @libraryclass  Provides an interface to a PL011 uart.\r
+  #\r
   PL011UartLib|Include/Library/PL011UartLib.h\r
 \r
 [Guids.common]\r