From eaf1e20af0294d79a176d2ac3b35fd4143163051 Mon Sep 17 00:00:00 2001
From: jacob <jacob@cda61777-01e9-0310-a592-d414129be87e>
Date: Sun, 23 Apr 2006 18:26:03 +0000
Subject: [PATCH] Sprinkle some header comments in various files in an attempt
 to explain what they're for.

git-svn-id: svn://svn.tartarus.org/sgt/putty@6639 cda61777-01e9-0310-a592-d414129be87e
---
 cmdline.c         | 5 +++++
 logging.c         | 4 ++++
 misc.h            | 4 ++++
 portfwd.c         | 4 ++++
 puttyps.h         | 4 ++++
 raw.c             | 4 ++++
 rlogin.c          | 4 ++++
 ssh.c             | 4 ++++
 sshdh.c           | 4 ++++
 sshdss.c          | 4 ++++
 telnet.c          | 4 ++++
 terminal.c        | 4 ++++
 windows/sizetip.c | 4 ++++
 windows/win_res.h | 4 ++++
 windows/wincons.c | 2 +-
 windows/windlg.c  | 4 ++++
 windows/window.c  | 5 +++++
 windows/wintime.c | 4 ++++
 18 files changed, 71 insertions(+), 1 deletion(-)

diff --git a/cmdline.c b/cmdline.c
index 39f57bbf..e8343427 100644
--- a/cmdline.c
+++ b/cmdline.c
@@ -1,3 +1,8 @@
+/*
+ * cmdline.c - command-line parsing shared between many of the
+ * PuTTY applications
+ */
+
 #include <stdio.h>
 #include <assert.h>
 #include <stdlib.h>
diff --git a/logging.c b/logging.c
index ab765b3b..8122a480 100644
--- a/logging.c
+++ b/logging.c
@@ -1,3 +1,7 @@
+/*
+ * Session logging.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <ctype.h>
diff --git a/misc.h b/misc.h
index f4363e44..49942aa5 100644
--- a/misc.h
+++ b/misc.h
@@ -1,3 +1,7 @@
+/*
+ * Header for misc.c.
+ */
+
 #ifndef PUTTY_MISC_H
 #define PUTTY_MISC_H
 
diff --git a/portfwd.c b/portfwd.c
index 54a68769..e6cf2005 100644
--- a/portfwd.c
+++ b/portfwd.c
@@ -1,3 +1,7 @@
+/*
+ * SSH port forwarding.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 
diff --git a/puttyps.h b/puttyps.h
index 1370bfd2..d1f3c37d 100644
--- a/puttyps.h
+++ b/puttyps.h
@@ -1,3 +1,7 @@
+/*
+ * Find the platform-specific header for this platform.
+ */
+
 #ifndef PUTTY_PUTTYPS_H
 #define PUTTY_PUTTYPS_H
 
diff --git a/raw.c b/raw.c
index 31d7490c..28da09f7 100644
--- a/raw.c
+++ b/raw.c
@@ -1,3 +1,7 @@
+/*
+ * "Raw" backend.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 
diff --git a/rlogin.c b/rlogin.c
index 2d2b288a..1b9a8069 100644
--- a/rlogin.c
+++ b/rlogin.c
@@ -1,3 +1,7 @@
+/*
+ * Rlogin backend.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <ctype.h>
diff --git a/ssh.c b/ssh.c
index 1a7880cc..38eb2bbd 100644
--- a/ssh.c
+++ b/ssh.c
@@ -1,3 +1,7 @@
+/*
+ * SSH backend.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdarg.h>
diff --git a/sshdh.c b/sshdh.c
index 48f277a7..f0abd3ec 100644
--- a/sshdh.c
+++ b/sshdh.c
@@ -1,3 +1,7 @@
+/*
+ * Diffie-Hellman implementation for PuTTY.
+ */
+
 #include "ssh.h"
 
 /*
diff --git a/sshdss.c b/sshdss.c
index 41974c23..22992fea 100644
--- a/sshdss.c
+++ b/sshdss.c
@@ -1,3 +1,7 @@
+/*
+ * Digital Signature Standard implementation for PuTTY.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <assert.h>
diff --git a/telnet.c b/telnet.c
index fe6f5cf9..50388337 100644
--- a/telnet.c
+++ b/telnet.c
@@ -1,3 +1,7 @@
+/*
+ * Telnet backend.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 
diff --git a/terminal.c b/terminal.c
index 72ff9f90..806d650c 100644
--- a/terminal.c
+++ b/terminal.c
@@ -1,3 +1,7 @@
+/*
+ * Terminal emulator.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <ctype.h>
diff --git a/windows/sizetip.c b/windows/sizetip.c
index 2073a09f..4f0a195f 100644
--- a/windows/sizetip.c
+++ b/windows/sizetip.c
@@ -1,3 +1,7 @@
+/*
+ * sizetip.c - resize tips for PuTTY(tel) terminal window.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <tchar.h>
diff --git a/windows/win_res.h b/windows/win_res.h
index d5f6b809..118f7495 100644
--- a/windows/win_res.h
+++ b/windows/win_res.h
@@ -1,3 +1,7 @@
+/*
+ * win_res.h - constants shared between win_res.rc2 and the C code.
+ */
+
 #ifndef PUTTY_WIN_RES_H
 #define PUTTY_WIN_RES_H
 
diff --git a/windows/wincons.c b/windows/wincons.c
index e0f0215f..7b763a20 100644
--- a/windows/wincons.c
+++ b/windows/wincons.c
@@ -1,5 +1,5 @@
 /*
- * console.c: various interactive-prompt routines shared between
+ * wincons.c - various interactive-prompt routines shared between
  * the Windows console PuTTY tools
  */
 
diff --git a/windows/windlg.c b/windows/windlg.c
index 019f6155..3f028019 100644
--- a/windows/windlg.c
+++ b/windows/windlg.c
@@ -1,3 +1,7 @@
+/*
+ * windlg.c - dialogs for PuTTY(tel), including the configuration dialog.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <limits.h>
diff --git a/windows/window.c b/windows/window.c
index 65bca731..e997ff06 100644
--- a/windows/window.c
+++ b/windows/window.c
@@ -1,3 +1,8 @@
+/*
+ * window.c - the PuTTY(tel) main program, which runs a PuTTY terminal
+ * emulator and backend in a window.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <ctype.h>
diff --git a/windows/wintime.c b/windows/wintime.c
index eea0cf62..eebed9e5 100644
--- a/windows/wintime.c
+++ b/windows/wintime.c
@@ -1,3 +1,7 @@
+/*
+ * wintime.c - Avoid trouble with time() returning (time_t)-1 on Windows.
+ */
+
 #include "putty.h"
 #include <time.h>
 
-- 
2.11.0