Add first-line comment describing C source's purpose.

I had a stab at them after a bit of a skim;  they're better than
nothing.

diff --git a/h/netsec.h b/h/netsec.h
index e22b39e3f461c10c4feee9f3e931d99c432b2048..c072990803948c5674a34d397c1cdd51107b3922 100644 (file)
--- a/h/netsec.h
+++ b/h/netsec.h
@@ -1,4 +1,4 @@
-/* Network security library routines for nmh.
+/* netsec.h -- network-security library routines.
  *
  * These are a common set of routines to handle network security for
  * things like SASL and OpenSSL.

diff --git a/h/oauth.h b/h/oauth.h
index d5098730a3ce75126befd4b6ec8e2bc550d8f4f0..605008a1c38f739745d008d2ddbdfc74516d9797 100644 (file)
--- a/h/oauth.h
+++ b/h/oauth.h
@@ -1,12 +1,12 @@
-/* Implementation of OAuth 2.0 [1] for XOAUTH2 in SMTP [2] and POP3 [3].
+/* oauth.h -- OAuth 2.0 implementation for XOAUTH2 in SMTP and POP3.
  *
  * Google defined XOAUTH2 for SMTP, and that's what we use here.  If other
  * providers implement XOAUTH2 or some similar OAuth-based SMTP authentication
  * protocol, it should be simple to extend this.
  *
- * [1] https://tools.ietf.org/html/rfc6749
- * [2] https://developers.google.com/gmail/xoauth2_protocol
- * [3] http://googleappsdeveloper.blogspot.com/2014/10/updates-on-authentication-for-gmail.html
+ * OAuth  https://tools.ietf.org/html/rfc6749
+ * SMTP   https://developers.google.com/gmail/xoauth2_protocol
+ * POP3   http://googleappsdeveloper.blogspot.com/2014/10/updates-on-authentication-for-gmail.html
  *
  * Presumably [2] should document POP3 and that is an over-sight.  As it stands,
  * that blog post is the closest we have to documentation.

diff --git a/sbr/credentials.c b/sbr/credentials.c
index 3aba7d80316e7e8a0d7f9bb2bf84c810b9e8e435..b34b967395949dbca85ec8ab742fbc9a8c339289 100644 (file)
--- a/sbr/credentials.c
+++ b/sbr/credentials.c
@@ -1,4 +1,6 @@
-/* This code is Copyright (c) 2013, by the authors of nmh.  See the
+/* credentials.c -- wrap configurable access to .netrc or similar files.
+ *
+ * This code is Copyright (c) 2013, by the authors of nmh.  See the
  * COPYRIGHT file in the root directory of the nmh distribution for
  * complete copyright information.
  */

diff --git a/sbr/encode_rfc2047.c b/sbr/encode_rfc2047.c
index 41fe786561271305ed57924b022ed54ce90f0a52..bc5fc1becc3ed00257e286ac025358e9e1994cfa 100644 (file)
--- a/sbr/encode_rfc2047.c
+++ b/sbr/encode_rfc2047.c
@@ -1,4 +1,4 @@
-/* Routines to encode message headers using RFC 2047-encoding.
+/* encode_rfc2047.c -- encode message headers using RFC 2047 encoding.
  *
  * This code is Copyright (c) 2002, by the authors of nmh.  See the
  * COPYRIGHT file in the root directory of the nmh distribution for

diff --git a/sbr/getpass.c b/sbr/getpass.c
index a6a1f13ce8e76c0d39bece68f16dc02b97e297b3..4b24af3c137299c3ce77097e46c6a01ec9bb2964 100644 (file)
--- a/sbr/getpass.c
+++ b/sbr/getpass.c
@@ -1,4 +1,6 @@
-/* Portions of this code are Copyright (c) 1988, 1993
+/* getpass.c -- read a password without echo.
+ *
+ * Portions of this code are Copyright (c) 1988, 1993
  *     The Regents of the University of California.  All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without

diff --git a/sbr/norm_charmap.c b/sbr/norm_charmap.c
index d9580bce27d0bc2795a5fa50cd68f5eef4b244d8..b10cde34a6429a9edc92712c683d04229f1c8a33 100644 (file)
--- a/sbr/norm_charmap.c
+++ b/sbr/norm_charmap.c
@@ -1,4 +1,6 @@
-/* The Single Unix Specification function nl_langinfo(CODESET)
+/* norm_charmap.c -- map locale's encoding to MIME charset.
+ *
+ * The Single Unix Specification function nl_langinfo(CODESET)
  * returns the name of the encoding used by the currently selected
  * locale:
  *

diff --git a/sbr/oauth.c b/sbr/oauth.c
index f286d1657025748bd05d4d95dc963a3cfabda0ba..3becfdef6868461d3ed7859fc914654352b3c490 100755 (executable)
--- a/sbr/oauth.c
+++ b/sbr/oauth.c
@@ -1,4 +1,6 @@
-/* This code is Copyright (c) 2014, by the authors of nmh.  See the
+/* oauth.c -- OAuth 2.0 implementation for XOAUTH2 in SMTP and POP3.
+ *
+ * This code is Copyright (c) 2014, by the authors of nmh.  See the
  * COPYRIGHT file in the root directory of the nmh distribution for
  * complete copyright information.
  */

diff --git a/sbr/oauth_prof.c b/sbr/oauth_prof.c
index c51cf0a4f931554408866dd1134cb04e8b02ebe7..3dc507324d411a7d9910db370b8c809d12f319dc 100644 (file)
--- a/sbr/oauth_prof.c
+++ b/sbr/oauth_prof.c
@@ -1,4 +1,6 @@
-/* This code is Copyright (c) 2014, by the authors of nmh.  See the
+/* oauth_prof.c -- OAuth 2.0 implementation for XOAUTH2 in SMTP and POP3.
+ *
+ * This code is Copyright (c) 2014, by the authors of nmh.  See the
  * COPYRIGHT file in the root directory of the nmh distribution for
  * complete copyright information.
  */

diff --git a/sbr/ruserpass.c b/sbr/ruserpass.c
index 6b1d1a137a24ff35c8d9c3902b2ba2bf2f416c85..1e43571e40663a784aac3b62db1b46b722e1ca75 100644 (file)
--- a/sbr/ruserpass.c
+++ b/sbr/ruserpass.c
@@ -1,4 +1,6 @@
-/* Portions of this code are
+/* ruserpass.c -- parse .netrc-format file.
+ *
+ * Portions of this code are
  * Copyright (c) 1985 Regents of the University of California.
  * All rights reserved.
  *