[edk2-devel] [PATCH v2 04/15] ArmPlatformPkg: Document libraries in ArmPlatformPkg.dec

[PierreGondois]

From: Pierre Gondois <Pierre.Gondois at arm.com>

This patch documents the libraries advertised in ArmPlatformPkg.dec.

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

Notes:
    V2:
     - Add documentation to the advertised libraries.
       This is a new patch. [Bret]

 ArmPlatformPkg/ArmPlatformPkg.dec | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#74476): https://edk2.groups.io/g/devel/message/74476
Mute This Topic: https://groups.io/mt/82406641/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-