aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2022-07-16 02:04:01 +0200
committerJohn Ankarström <john@ankarstrom.se>2022-07-16 02:04:01 +0200
commitbd812f7d928aa64f837e2fbd23e372ab65d03d87 (patch)
tree4774986fd31f7432a40f6de986c1aebe324ccfb4 /README
parent2fed063bf167dcb8f900c4a1f11b0a02ae115d16 (diff)
downloadEpisodeBrowser-bd812f7d928aa64f837e2fbd23e372ab65d03d87.tar.gz
README: Add information about Hungarian notation.
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
index b4d27ed..8aeed8d 100644
--- a/README
+++ b/README
@@ -53,3 +53,23 @@ following additional programs are required:
To build b/EpisodeBrowser.exe, issue `make' in the root directory of
the project.
+
+Hacking
+~~~~~~~
+Like many Windows programs, Episode Browser uses Hungarian notation.
+Following is a list of prefixes commonly used in the code base:
+
+ lp = pointer ("long/far pointer")
+ b = boolean (BOOL, int)
+ i = integer
+ siz = size (size_t)
+ h = handle
+ l = long
+ w = "word" (WPARAM)
+ dw = "double word" (DWORD)
+ sz = zero-terminated string (char *)
+ wsz = ... wide string (wchar_t *)
+ tsz = ... tstring (TCHAR *)
+ sm = ... managed string (std::string)
+ wsm = ... (std::wstring)
+ tsm = ... (std::basic_string<TCHAR>)