adding copyright and license headers and prep for elpa proposal

6 files changed, 126 insertions, 6 deletions

diff --git a/lisp/hc.el b/lisp/hc.el
index 907a3d7..f6239f6 100644
--- a/lisp/hc.el
+++ b/lisp/hc.el
@@ -1,4 +1,31 @@
-;; -*- lexical-binding: t; -*-
+;;; hc.el --- Haskell codebase explorer -*- lexical-binding: t; -*-
+
+;; Author: Yuchen Pei <id@ypei.org>
+;; Maintainer: Yuchen Pei <id@ypei.org>
+;; Created: 2022
+;; Version: 0
+;; Keywords: haskell
+;; Package-Requires: ((emacs "28") (haskell-mode))
+;; Package-Type: multi
+;; Homepage: https://g.ypei.me/hcel.git
+
+;; Copyright (C) 2022 Yuchen Pei.
+;; 
+;; This file is part of hcel.
+;; 
+;; hcel is free software: you can redistribute it and/or modify it under
+;; the terms of the GNU Affero General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+;; 
+;; hcel is distributed in the hope that it will be useful, but WITHOUT
+;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;; or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General
+;; Public License for more details.
+;; 
+;; You should have received a copy of the GNU Affero General Public
+;; License along with hcel.  If not, see <https://www.gnu.org/licenses/>.
+
 (require 'hcel-source)
 (require 'hcel-outline)
 (require 'hcel-results)
diff --git a/lisp/hcel-client.el b/lisp/hcel-client.el
index 3a484f6..1aa0d0f 100644
--- a/lisp/hcel-client.el
+++ b/lisp/hcel-client.el
@@ -1,4 +1,22 @@
-;; -*- lexical-binding: t; -*-
+;;; hcel-client.el --- talks to a haskell-code-server. -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2022 Yuchen Pei.
+;; 
+;; This file is part of hcel.
+;; 
+;; hcel is free software: you can redistribute it and/or modify it under
+;; the terms of the GNU Affero General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+;; 
+;; hcel is distributed in the hope that it will be useful, but WITHOUT
+;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;; or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General
+;; Public License for more details.
+;; 
+;; You should have received a copy of the GNU Affero General Public
+;; License along with hcel.  If not, see <https://www.gnu.org/licenses/>.
+
 (defcustom hcel-endpoint "localhost:8080"
   "hcel endpoint"
   :group 'hcel)
diff --git a/lisp/hcel-outline.el b/lisp/hcel-outline.el
index b5ad54a..a46db14 100644
--- a/lisp/hcel-outline.el
+++ b/lisp/hcel-outline.el
@@ -1,4 +1,22 @@
-;; -*- lexical-binding: t; -*-
+;;; hcel-outline.el --- shows package-module-identifier hierarchy in an outline mode -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2022 Yuchen Pei.
+;; 
+;; This file is part of hcel.
+;; 
+;; hcel is free software: you can redistribute it and/or modify it under
+;; the terms of the GNU Affero General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+;; 
+;; hcel is distributed in the hope that it will be useful, but WITHOUT
+;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;; or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General
+;; Public License for more details.
+;; 
+;; You should have received a copy of the GNU Affero General Public
+;; License along with hcel.  If not, see <https://www.gnu.org/licenses/>.
+
 (defvar hcel-outline-buffer-name "*hcel-outline*")
 (defvar hcel-outline-indentation 2)
 
diff --git a/lisp/hcel-results.el b/lisp/hcel-results.el
index 6f9a29e..5f27b6a 100644
--- a/lisp/hcel-results.el
+++ b/lisp/hcel-results.el
@@ -1,7 +1,29 @@
-;; -*- lexical-binding: t; -*-
+;;; hc-results.el --- Shows query results in a compilation mode -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2022 Yuchen Pei.
+;; 
+;; This file is part of hcel.
+;; 
+;; hcel is free software: you can redistribute it and/or modify it under
+;; the terms of the GNU Affero General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+;; 
+;; hcel is distributed in the hope that it will be useful, but WITHOUT
+;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;; or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General
+;; Public License for more details.
+;; 
+;; You should have received a copy of the GNU Affero General Public
+;; License along with hcel.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
 ;; hcel-results provides functions for hcel modes derived from
 ;; compilation-mode.
 
+;;; Code:
+
 (defun hcel-results-next-error-no-open (n)
   (interactive "p")
   (hcel-results-next-error-internal n))
diff --git a/lisp/hcel-source.el b/lisp/hcel-source.el
index b92f954..688fff1 100644
--- a/lisp/hcel-source.el
+++ b/lisp/hcel-source.el
@@ -1,4 +1,22 @@
-;; -*- lexical-binding: t; -*-
+;;; hcel-source.el --- displays Haskell module source. -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2022 Yuchen Pei.
+;; 
+;; This file is part of hcel.
+;; 
+;; hcel is free software: you can redistribute it and/or modify it under
+;; the terms of the GNU Affero General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+;; 
+;; hcel is distributed in the hope that it will be useful, but WITHOUT
+;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;; or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General
+;; Public License for more details.
+;; 
+;; You should have received a copy of the GNU Affero General Public
+;; License along with hcel.  If not, see <https://www.gnu.org/licenses/>.
+
 (require 'hcel-client)
 (define-derived-mode hcel-mode special-mode "hcel"
   "Major mode for exploring Haskell codebases"
diff --git a/lisp/hcel-utils.el b/lisp/hcel-utils.el
index 9526521..18e1062 100644
--- a/lisp/hcel-utils.el
+++ b/lisp/hcel-utils.el
@@ -1,4 +1,21 @@
-;; -*- lexical-binding: t; -*-
+;;; hc-utils.el --- Commonly used utilities -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2022 Yuchen Pei.
+;; 
+;; This file is part of hcel.
+;; 
+;; hcel is free software: you can redistribute it and/or modify it under
+;; the terms of the GNU Affero General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+;; 
+;; hcel is distributed in the hope that it will be useful, but WITHOUT
+;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;; or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General
+;; Public License for more details.
+;; 
+;; You should have received a copy of the GNU Affero General Public
+;; License along with hcel.  If not, see <https://www.gnu.org/licenses/>.
 
 ;; data conversions
 (defun hcel-parse-package-id (package-id &optional divider)