Merge pull request #33 from prashcr/comment-headers

Add comment headers for every source file

18 files changed, 51 insertions, 12 deletions

diff --git a/ale_linters/c/gcc.vim b/ale_linters/c/gcc.vim
index 083c318e..500542d7 100644
--- a/ale_linters/c/gcc.vim
+++ b/ale_linters/c/gcc.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: gcc linter for c files
+
 if exists('g:loaded_ale_linters_c_gcc')
     finish
 endif
diff --git a/ale_linters/coffee/coffeelint.vim b/ale_linters/coffee/coffeelint.vim
index 4083c246..aba29c4a 100644
--- a/ale_linters/coffee/coffeelint.vim
+++ b/ale_linters/coffee/coffeelint.vim
@@ -1,4 +1,5 @@
-" Author: prashcr - https://github.com/prashcr
+" Author: Prashanth Chandra https://github.com/prashcr
+" Description: coffeelint linter for coffeescript files
 
 if exists('g:loaded_ale_linters_coffee_coffeelint')
     finish
diff --git a/ale_linters/d/dmd.vim b/ale_linters/d/dmd.vim
index 25d4b912..4c109e08 100644
--- a/ale_linters/d/dmd.vim
+++ b/ale_linters/d/dmd.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: "dmd for D files"
+
 if exists('g:loaded_ale_linters_d_dmd')
     finish
 endif
diff --git a/ale_linters/fortran/gcc.vim b/ale_linters/fortran/gcc.vim
index 6df2c65a..3e97fea9 100644
--- a/ale_linters/fortran/gcc.vim
+++ b/ale_linters/fortran/gcc.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: gcc for Fortran files
+
 if exists('g:loaded_ale_linters_fortran_gcc')
     finish
 endif
diff --git a/ale_linters/haskell/ghc.vim b/ale_linters/haskell/ghc.vim
index 2fb5e52b..71988a21 100644
--- a/ale_linters/haskell/ghc.vim
+++ b/ale_linters/haskell/ghc.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: ghc for Haskell files
+
 if exists('g:loaded_ale_linters_haskell_ghc')
     finish
 endif
diff --git a/ale_linters/javascript/eslint.vim b/ale_linters/javascript/eslint.vim
index 8f829e28..8a4e03bf 100644
--- a/ale_linters/javascript/eslint.vim
+++ b/ale_linters/javascript/eslint.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: eslint for JavaScript files
+
 if exists('g:loaded_ale_linters_javascript_eslint')
     finish
 endif
diff --git a/ale_linters/javascript/jscs.vim b/ale_linters/javascript/jscs.vim
index 16b35cea..263ea88d 100644
--- a/ale_linters/javascript/jscs.vim
+++ b/ale_linters/javascript/jscs.vim
@@ -1,4 +1,5 @@
 " Author: Chris Kyrouac - https://github.com/fijshion
+" Description: jscs for JavaScript files
 
 if exists('g:loaded_ale_linters_javascript_jscs')
     finish
diff --git a/ale_linters/javascript/jshint.vim b/ale_linters/javascript/jshint.vim
index 2de755c0..61f8faa8 100644
--- a/ale_linters/javascript/jshint.vim
+++ b/ale_linters/javascript/jshint.vim
@@ -1,4 +1,5 @@
 " Author: Chris Kyrouac - https://github.com/fijshion
+" Description: JSHint for Javascript files
 
 if exists('g:loaded_ale_linters_javascript_jshint')
     finish
diff --git a/ale_linters/python/flake8.vim b/ale_linters/python/flake8.vim
index 19dfc22e..95ab2a28 100644
--- a/ale_linters/python/flake8.vim
+++ b/ale_linters/python/flake8.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: flake8 for python files
+
 if exists('g:loaded_ale_linters_python_flake8')
     finish
 endif
diff --git a/ale_linters/ruby/rubocop.vim b/ale_linters/ruby/rubocop.vim
index cee70533..1acb2636 100644
--- a/ale_linters/ruby/rubocop.vim
+++ b/ale_linters/ruby/rubocop.vim
@@ -1,4 +1,5 @@
 " Author: ynonp - https://github.com/ynonp
+" Description: rubocop for Ruby files
 
 if exists('g:loaded_ale_linters_ruby_rubocop')
     finish
diff --git a/ale_linters/sh/shell.vim b/ale_linters/sh/shell.vim
index 6c93933a..f5987c03 100644
--- a/ale_linters/sh/shell.vim
+++ b/ale_linters/sh/shell.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: Lints sh files using bash -n
+
 if exists('g:loaded_ale_linters_sh_shell')
     finish
 endif
diff --git a/dmd-wrapper b/dmd-wrapper
index 678aeb99..6db47d14 100755
--- a/dmd-wrapper
+++ b/dmd-wrapper
@@ -1,7 +1,8 @@
 #!/bin/bash -eu
 
-# This script wraps DMD so we can get something which is capable of reading
-# D code from stdin.
+# Author: w0rp <devw0rp@gmail.com>
+# Description: This script wraps DMD so we can get something which is capable of reading
+#   D code from stdin.
 
 temp_file=`mktemp`
 mv "$temp_file" "$temp_file".d
diff --git a/plugin/ale/aaflags.vim b/plugin/ale/aaflags.vim
index 9f022beb..6c0371cd 100644
--- a/plugin/ale/aaflags.vim
+++ b/plugin/ale/aaflags.vim
@@ -1,6 +1,6 @@
-" This file sets up configuration settings for the ALE plugin.
-" Flags can be set in vimrc files and so on to disable particular features,
-" etc.
+" Author: w0rp <devw0rp@gmail.com>
+" Description: This file sets up configuration settings for the ALE plugin.
+"   Flags can be set in vimrc files and so on to disable particular features
 
 if exists('g:loaded_ale_flags')
     finish
diff --git a/plugin/ale/cursor.vim b/plugin/ale/cursor.vim
index 234060a8..7ebdbf1c 100644
--- a/plugin/ale/cursor.vim
+++ b/plugin/ale/cursor.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: Echoes lint message for the current line, if any
+
 if exists('g:loaded_ale_cursor')
     finish
 endif
diff --git a/plugin/ale/sign.vim b/plugin/ale/sign.vim
index 46d74fc6..9ea4b2d1 100644
--- a/plugin/ale/sign.vim
+++ b/plugin/ale/sign.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: Draws error and warning signs into signcolumn
+
 if exists('g:loaded_ale_sign')
     finish
 endif
diff --git a/plugin/ale/util.vim b/plugin/ale/util.vim
index 34cacca1..cda7a7db 100644
--- a/plugin/ale/util.vim
+++ b/plugin/ale/util.vim
@@ -1,3 +1,6 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: Contains miscellaneous functions
+
 if exists('g:loaded_ale_util')
     finish
 endif
diff --git a/plugin/ale/zmain.vim b/plugin/ale/zmain.vim
index 4cef1ab7..26085b66 100644
--- a/plugin/ale/zmain.vim
+++ b/plugin/ale/zmain.vim
@@ -1,3 +1,7 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: Main entry point for this plugin
+"   Loads linters and manages lint jobs
+
 if exists('g:loaded_ale_zmain')
     finish
 endif
diff --git a/stdin-wrapper b/stdin-wrapper
index 96d08919..09e9436e 100755
--- a/stdin-wrapper
+++ b/stdin-wrapper
@@ -1,12 +1,12 @@
 #!/bin/bash -eu
 
-# This script implements a wrapper for any program which does not accept
-# stdin input on most Unix machines. The input to the script is read to a
-# temporary file, and the first argument sets a particular file extension
-# for the temporary file.
-#
-# All of the following arguments are read as command to run.
+# Author: w0rp <devw0rp@gmail.com>
+# Description: This script implements a wrapper for any program which does not accept
+#   stdin input on most Unix machines. The input to the script is read to a
+#   temporary file, and the first argument sets a particular file extension
+#   for the temporary file.
 
+# All of the following arguments are read as command to run.
 file_extension="$1"
 shift