]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Scripts/PackageDocumentTools/plugins/EdkPlugins/basemodel/doxygen.py
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / BaseTools / Scripts / PackageDocumentTools / plugins / EdkPlugins / basemodel / doxygen.py
index 2d0cc9d96e1f51a193c0e79ca6b725b468423208..a8f87751a0fa9d3bfcb73f917c66ad93eed55954 100644 (file)
@@ -2,18 +2,14 @@
 #\r
 # Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
 #\r
-# This program and the accompanying materials are licensed and made available\r
-# under the terms and conditions of the BSD License which accompanies this\r
-# distribution. The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
-#\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+# SPDX-License-Identifier: BSD-2-Clause-Patent\r
 #\r
 \r
+from __future__ import print_function\r
+from __future__ import absolute_import\r
 import os\r
 \r
-from message import *\r
+from .message import *\r
 \r
 class BaseDoxygeItem:\r
     def __init__(self, name, tag=''):\r
@@ -58,14 +54,14 @@ class Page(BaseDoxygeItem):
         return subpage\r
 \r
     def AddPages(self, pageArray):\r
-        if pageArray == None:\r
+        if pageArray is None:\r
             return\r
         for page in pageArray:\r
             self.AddPage(page)\r
 \r
     def AddSection(self, section):\r
         self.mSections.append(section)\r
-        self.mSections.sort(cmp=lambda x,y: cmp(x.mName.lower(), y.mName.lower()))\r
+        self.mSections.sort(key=lambda x: x.mName.lower())\r
 \r
     def Generate(self):\r
         if self.mIsMainPage:\r
@@ -78,7 +74,7 @@ class Page(BaseDoxygeItem):
             self.mText.append(self.mDescription)\r
         endIndex = len(self.mText)\r
 \r
-        self.mSections.sort()\r
+        self.mSections.sort(key=lambda x: x.mName.lower())\r
         for sect in self.mSections:\r
             self.mText += sect.Generate()\r
 \r
@@ -90,7 +86,7 @@ class Page(BaseDoxygeItem):
             self.mText.insert(endIndex, '<ul>')\r
             endIndex += 1\r
             if self.mIsSort:\r
-                self.mSubPages.sort(cmp=lambda x,y: cmp(x.mName.lower(), y.mName.lower()))\r
+                self.mSubPages.sort(key=lambda x: x.mName.lower())\r
             for page in self.mSubPages:\r
                 self.mText.insert(endIndex, '<li>\subpage %s \"%s\" </li>' % (page.mTag, page.mName))\r
                 endIndex += 1\r
@@ -115,7 +111,7 @@ class DoxygenFile(Page):
             f = open(self.mFilename, 'w')\r
             f.write('\n'.join(str))\r
             f.close()\r
-        except IOError, e:\r
+        except IOError as e:\r
             ErrorMsg ('Fail to write file %s' % self.mFilename)\r
             return False\r
 \r
@@ -370,7 +366,7 @@ class DoxygenConfigFile:
         self.mWarningFile = str.replace('\\', '/')\r
 \r
     def FileExists(self, path):\r
-        if path == None:\r
+        if path is None:\r
             return False\r
         if len(path) == 0:\r
             return False\r
@@ -382,7 +378,7 @@ class DoxygenConfigFile:
         return False\r
 \r
     def AddFile(self, path):\r
-        if path == None:\r
+        if path is None:\r
             return\r
 \r
         if len(path) == 0:\r
@@ -429,7 +425,7 @@ class DoxygenConfigFile:
             f = open(path, 'w')\r
             f.write(text)\r
             f.close()\r
-        except IOError, e:\r
+        except IOError as e:\r
             ErrorMsg ('Fail to generate doxygen config file %s' % path)\r
             return False\r
 \r
@@ -446,4 +442,4 @@ if __name__== '__main__':
     p.AddPage(Page('PCD', 'pcds'))\r
 \r
     df.Generate()\r
-    print df\r
+    print(df)\r