add notes to move to winAPI module

seanbudd · Aug 31, 2022 · Aug 19, 2022 · Aug 19, 2022 · Aug 19, 2022 · Aug 22, 2022
commit 73d0d07e4144c86de921fe33c9a6daa751872507
@@ -1,3 +1,12 @@
+# A part of NonVisual Desktop Access (NVDA)
+# Copyright (C) 2011-2022 NV Access Limited
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
+
+"""
+When working on this file, consider moving to winAPI.
+"""
+
 from ctypes import windll, Structure, c_ubyte, c_uint32, c_void_p, c_int, c_float, POINTER, byref, c_ulong
 from ctypes.wintypes import LONG, DWORD, WORD, BOOL
 from contextlib import contextmanager

@@ -3,9 +3,11 @@
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
 
+"""
+When working on this file, consider moving to winAPI.
+"""
+
 import threading
-import comtypes.client
-import time
 from ctypes import *
 from ctypes.wintypes import *
 import watchdog

@@ -4,7 +4,11 @@
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
 
-"""Functions that wrap Windows API functions from kernel32.dll and advapi32.dll"""
+"""
+Functions that wrap Windows API functions from kernel32.dll and advapi32.dll.
+
+When working on this file, consider moving to winAPI.
+"""
 
 import contextlib
 import ctypes

@@ -3,7 +3,11 @@
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
 
-"""Functions that wrap Windows API functions from user32.dll"""
+"""
+Functions that wrap Windows API functions from user32.dll.
+
+When working on this file, consider moving to winAPI.
+"""
 
 import contextlib
 from ctypes import *

@@ -6,6 +6,8 @@
 """A module used to record Windows versions.
 It is also used to define feature checks such as
 making sure NVDA can run on a minimum supported version of Windows.
+
+When working on this file, consider moving to winAPI.
 """
 
 from typing import Optional

@@ -1,10 +1,12 @@
-#windowUtils.py
-#A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2013 NV Access Limited
-#This file is covered by the GNU General Public License.
-#See the file COPYING for more details.
+# A part of NonVisual Desktop Access (NVDA)
+# Copyright (C) 2013 NV Access Limited
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
 
-"""Utilities for working with windows (HWNDs).
+"""
+Utilities for working with windows (HWNDs).
+
+When working on this file, consider moving to winAPI.
 """
 
 import ctypes