[reactos] 01/01: [NTGDI][NTUSER][INCLUDE] Add 'See also:' comments for structures (#4872)

[Katayama Hirofumi MZ]

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=0bc6bd64807b58c79051f…

commit 0bc6bd64807b58c79051f4764947624927040427
Author:     Katayama Hirofumi MZ <katayama.hirofumi.mz(a)gmail.com>
AuthorDate: Sat Nov 12 20:27:50 2022 +0900
Commit:     GitHub <noreply(a)github.com>
CommitDate: Sat Nov 12 20:27:50 2022 +0900

    [NTGDI][NTUSER][INCLUDE] Add 'See also:' comments for structures (#4872)
    
    Add 'See also' URLs to some undocumented structures.
---
 win32ss/gdi/eng/engobjects.h |  5 ++++-
 win32ss/gdi/ntgdi/brush.h    |  4 ++++
 win32ss/gdi/ntgdi/dc.h       |  5 ++++-
 win32ss/include/ntgdihdl.h   |  4 ++++
 win32ss/include/ntuser.h     | 28 ++++++++++++++++++++++++++++
 win32ss/user/ntuser/win32.h  | 13 +++++++++++--
 6 files changed, 55 insertions(+), 4 deletions(-)

diff --git a/win32ss/gdi/eng/engobjects.h b/win32ss/gdi/eng/engobjects.h
index 6c3476f57ea..29f7f0f8709 100644
--- a/win32ss/gdi/eng/engobjects.h
+++ b/win32ss/gdi/eng/engobjects.h
@@ -45,7 +45,10 @@ typedef struct _RWNDOBJ {
   SURFOBJ *psoOwner;
 } RWNDOBJ;
 
-/* EXtended CLip and Window Region Objects */
+/*
+ * XCLIPOBJ structure --- EXtended CLip and Window Region Objects.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/XCLIPOBJ
+ */
 #ifdef __cplusplus
 typedef struct _XCLIPOBJ : _CLIPOBJ, _RWNDOBJ
 {
diff --git a/win32ss/gdi/ntgdi/brush.h b/win32ss/gdi/ntgdi/brush.h
index 99d29258041..8d24021def3 100644
--- a/win32ss/gdi/ntgdi/brush.h
+++ b/win32ss/gdi/ntgdi/brush.h
@@ -62,6 +62,10 @@ class BRUSH;
 typedef class BRUSH *PBRUSH;
 #endif
 
+/*
+ * EBRUSHOBJ structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/EBRUSHOBJ
+ */
 typedef struct _EBRUSHOBJ
 {
     BRUSHOBJ    BrushObject;
diff --git a/win32ss/gdi/ntgdi/dc.h b/win32ss/gdi/ntgdi/dc.h
index 358527103aa..3da0376b8ed 100644
--- a/win32ss/gdi/ntgdi/dc.h
+++ b/win32ss/gdi/ntgdi/dc.h
@@ -88,7 +88,10 @@ typedef struct _DCLEVEL
   SIZE              sizl;
 } DCLEVEL, *PDCLEVEL;
 
-/* The DC object structure */
+/*
+ * The DC object structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/DC
+ */
 typedef struct _DC
 {
   /* Header for all gdi objects in the handle table.
diff --git a/win32ss/include/ntgdihdl.h b/win32ss/include/ntgdihdl.h
index 8296be8ff22..d03c06c216a 100644
--- a/win32ss/include/ntgdihdl.h
+++ b/win32ss/include/ntgdihdl.h
@@ -284,6 +284,10 @@ typedef struct _LDC
     DWORD dwData[5];
 } LDC, *PLDC;
 
+/*
+ * DC_ATTR structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/DC_ATTR
+ */
 typedef struct _DC_ATTR
 {
     PVOID pvLDC;
diff --git a/win32ss/include/ntuser.h b/win32ss/include/ntuser.h
index f5241d8350f..cd7fcdf7034 100644
--- a/win32ss/include/ntuser.h
+++ b/win32ss/include/ntuser.h
@@ -126,6 +126,10 @@ RtlLargeStringToUnicodeString(
 
 #define NB_HOOKS (WH_MAXHOOK - WH_MINHOOK + 1)
 
+/*
+ * DESKTOPINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/DESKTOP
+ */
 typedef struct _DESKTOPINFO
 {
     PVOID pvDesktopBase;
@@ -157,6 +161,10 @@ typedef struct _DESKTOPINFO
 #define CTI_THREADSYSLOCK 0x0001
 #define CTI_INSENDMESSAGE 0x0002
 
+/*
+ * CLIENTTHREADINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/CLIENTTHREADINFO
+ */
 typedef struct _CLIENTTHREADINFO
 {
     DWORD CTI_flags;
@@ -297,6 +305,10 @@ typedef struct _CALLBACKWND
 #define CI_IMMACTIVATE       0x00000040
 #define CI_TFSDISABLED       0x00000400
 
+/*
+ * CLIENTINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/CLIENTINFO
+ */
 typedef struct _CLIENTINFO
 {
     ULONG_PTR CI_flags;
@@ -669,6 +681,10 @@ typedef struct _SBINFOEX
 #define WPF_MININIT 0x0008
 #define WPF_MAXINIT 0x0010
 
+/*
+ * WND structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/WND
+ */
 typedef struct _WND
 {
     THRDESKHEAD head;
@@ -975,6 +991,10 @@ typedef struct tagDPISERVERINFO
 #define PUSIF_LISTBOXSMOOTHSCROLLING 0x08
 #define PUSIF_KEYBOARDCUES           0x20
 
+/*
+ * PERUSERSERVERINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/SERVERINFO
+ */
 typedef struct _PERUSERSERVERINFO
 {
     INT aiSysMet[SM_CMETRICS];
@@ -1017,6 +1037,10 @@ typedef struct _PERUSERSERVERINFO
     DWORD dwRIPFlags;
 } PERUSERSERVERINFO, *PPERUSERSERVERINFO;
 
+/*
+ * SERVERINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/SERVERINFO
+ */
 typedef struct tagSERVERINFO
 {
     DWORD dwSRVIFlags;
@@ -1092,6 +1116,10 @@ typedef struct _WNDMSG
     PINT abMsgs;
 } WNDMSG, *PWNDMSG;
 
+/*
+ * SHAREDINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/SHAREDINFO
+ */
 typedef struct _SHAREDINFO
 {
     PSERVERINFO psi;         /* Global Server Info */
diff --git a/win32ss/user/ntuser/win32.h b/win32ss/user/ntuser/win32.h
index 9514b48c3ca..9f97725ff6b 100644
--- a/win32ss/user/ntuser/win32.h
+++ b/win32ss/user/ntuser/win32.h
@@ -72,6 +72,10 @@ typedef struct _W32THREAD
 
 struct tagIMC;
 
+/*
+ * THREADINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/THREADINFO
+ */
 #ifdef __cplusplus
 typedef struct _THREADINFO : _W32THREAD
 {
@@ -200,8 +204,9 @@ typedef struct _W32HEAP_USER_MAPPING
 
 
 /*
- Information from STARTUPINFOW, psdk/winbase.h.
- Set from PsGetCurrentProcess()->Peb->ProcessParameters.
+ * Information from STARTUPINFOW, psdk/winbase.h.
+ * Set from PsGetCurrentProcess()->Peb->ProcessParameters.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/PROCESSINFO
 */
 typedef struct tagUSERSTARTUPINFO
 {
@@ -236,6 +241,10 @@ typedef struct _W32PROCESS
 
 #define CLIBS 32
 
+/*
+ * PROCESSINFO structure.
+ * See also: https://reactos.org/wiki/Techwiki:Win32k/PROCESSINFO
+ */
 #ifdef __cplusplus
 typedef struct _PROCESSINFO : _W32PROCESS
 {