Add more aliases and organize list

musm · Jul 29, 2020 · 8cc8209 · 8cc8209
1 parent b23c6bd
commit 8cc8209
Show file tree

Hide file tree

Showing 2 changed files with 202 additions and 383 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -63,95 +63,121 @@ directly translatable without manually looking up the myriad Windows data types.
 
 ## Alias List
 
-The following aliases are defined:
+The aliases defined in this package are provided below. Refer to
+[https://docs.microsoft.com/en-us/windows/win32/winprog/windows-data-types](https://docs.microsoft.com/en-us/windows/win32/winprog/windows-data-types)
+for detailed documentation on each constant.
 ```
-FALSE = Cint(0)
-TRUE = Cint(1)
-
-BOOL = Cint
-BOOLEAN = BYTE
-BYTE = Cuchar
-CCHAR = Cchar
-CHAR = Cchar
-COLORREF = DWORD
-DWORD = Culong
+FALSE     = Cint(0)
+TRUE      = Cint(1)
+
+BYTE      = Cuchar
+WORD      = Cushort
+DWORD     = Culong
 DWORDLONG = UInt64
-DWORD32 = UInt32
-DWORD64 = UInt64
-FLOAT = Cfloat
-HACCEL = HANDLE
+DWORD32   = UInt32
+DWORD64   = UInt64
+
+BOOL      = Cint
+BOOLEAN   = BYTE
+
+CHAR      = Cchar
+CCHAR     = Cchar
+
+FLOAT     = Cfloat
+
+LONG      = Culong
+ULONG     = Culong
+LONG32    = Cint
+LONG64    = Int64
+LONG_PTR  = Int
+
+SHORT     = Cshort
+USHORT    = Cushort
+
+ATOM      = WORD
+LANGID    = WORD
+
+COLORREF  = DWORD
+LGRPID    = DWORD
+LCTYPE    = DWORD
+
+LCID      = DWORD
+
+INT       = Int32
+INT8      = Int8
+INT16     = Int16
+INT32     = Int32
+INT64     = Int64
+INT_PTR   = Int
+UINT_PTR  = UInt
+
+WPARAM    = UINT_PTR
+LPARAM    = LONG_PTR
+
 HANDLE = Ptr{Cvoid}
-HBITMAP = HANDLE
-HBRUSH = HANDLE
-HCOLORSPACE = HANDLE
-HCONV = HANDLE
-HCONVLIST = HANDLE
-HCURSOR = HICON
-HDC = HANDLE
-HDDEDATA = HANDLE
-HDESK = HANDLE
-HDROP = HANDLE
-HDWP = HANDLE
-HENHMETAFILE = HANDLE
-HFILE = Cint
-HFONT = HANDLE
-HGDIOBJ = HANDLE
-HGLOBAL = HANDLE
-HHOOK = HANDLE
-HICON = HANDLE
-HINSTANCE = HANDLE
-HKEY = HANDLE
-HKL = HANDLE
-HLOCAL = HANDLE
-HMENU = HANDLE
-HMETAFILE = HANDLE
-HMODULE = HANDLE
-HMONITOR = HANDLE
-HPALETTE = HANDLE
-HPEN = HANDLE
-HRESULT = Clong
-HRGN = HANDLE
-HRSRC = HANDLE
-HSZ = HANDLE
-HWINSTA = HANDLE
-HWND = HANDLE
-INT = Cint
-PHANDLE = Ptr{HANDLE}
-PVOID = Ptr{Cvoid}
-LPVOID = Ptr{Cvoid}
-SHORT = Cshort
-UCHAR = Cuchar
-USHORT = Cushort
-VOID = Cvoid
-WCHAR = Cwchar_t
-WORD = Cushort
-PWCHAR = Ptr{WCHAR}
-PWORD = Ptr{WORD}
-LPWORD = Ptr{WORD}
-PDWORD = Ptr{DWORD}
-LPDWORD = Ptr{DWORD}
 
-PSTR = Ptr{CHAR} # char*
-LPSTR = Ptr{CHAR} # char*
+HACCEL       = HANDLE
+HBITMAP      = HANDLE
+HBRUSH       = HANDLE
+HCOLORSPACE  = HANDLE
+HCONV        = HANDLE
+HCONVLIST    = HANDLE
+HDC          = HANDLE
+HDDEDATA     = HANDLE
+HDESK        = HANDLE
+HDROP        = HANDLE
+HDWP         = HANDLE
+HENHMETAFILE = HANDLE
+HFILE        = Cint
+HFONT        = HANDLE
+HGDIOBJ      = HANDLE
+HGLOBAL      = HANDLE
+HHOOK        = HANDLE
+HICON        = HANDLE
+HCURSOR      = HICON
+HINSTANCE    = HANDLE
+HKEY         = HANDLE
+HKL          = HANDLE
+HLOCAL       = HANDLE
+HMENU        = HANDLE
+HMETAFILE    = HANDLE
+HMODULE      = HANDLE
+HMONITOR     = HANDLE
+HPALETTE     = HANDLE
+HPEN         = HANDLE
+HRESULT      = Clong
+HRGN         = HANDLE
+HRSRC        = HANDLE
+HSZ          = HANDLE
+HWINSTA      = HANDLE
+HWND         = HANDLE
 
-PCSTR  = Ptr{CHAR} # char*
-LPCSTR = Ptr{CHAR} # char*
+PHANDLE = Ptr{HANDLE}
 
-PWSTR = Ptr{WCHAR} # wchar_t*
-LPWSTR = Ptr{WCHAR} # wchar_t*
+UCHAR   = Cuchar
+WCHAR   = Cwchar_t
+PWCHAR  = Ptr{WCHAR}
 
-PCWSTR = Ptr{WCHAR} # wchar_t*
-LPCWSTR = Ptr{WCHAR} # const wchar_t*
-```
+PWORD   = Ptr{WORD}
+LPWORD  = Ptr{WORD}
+PDWORD  = Ptr{DWORD}
+LPDWORD = Ptr{DWORD}
 
+VOID    = Cvoid
+PVOID   = Ptr{Cvoid}
+LPVOID  = Ptr{Cvoid}
+LPCVOID = Ptr{Cvoid}
 
-# Detailed Definitions
+LPINT   = Ptr{Cint}
+PINT    = Ptr{Cint}
 
-Below we include detailed documentation for a few of the aliases defined in this package.
-We refer to
-[https://docs.microsoft.com/en-us/windows/win32/winprog/windows-data-types](https://docs.microsoft.com/en-us/windows/win32/winprog/windows-data-types)
-for those not included below.
+PSTR    = Ptr{CHAR}
+PCSTR   = Ptr{CHAR}
+LPSTR   = Ptr{CHAR}
+LPCSTR  = Ptr{CHAR}
 
-```@autodocs
-Modules = [WinTypes]
+PWSTR   = Ptr{WCHAR}
+PCWSTR  = Ptr{WCHAR}
+LPWSTR  = Ptr{WCHAR}
+LPCWSTR = Ptr{WCHAR}
 ```