Merge pull request #33 from prashcr/comment-headers

Add comment headers for every source file

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

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

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

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

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

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

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

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

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

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

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

dmd-wrapper

@@ -1,6 +1,7 @@
 #!/bin/bash -eu
 
-# This script wraps DMD so we can get something which is capable of reading
+# 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`

plugin/ale/aaflags.vim

@@ -1,6 +1,6 @@
-" This file sets up configuration settings for the ALE plugin.
+" Author: w0rp <devw0rp@gmail.com>
-" Flags can be set in vimrc files and so on to disable particular features,
+" Description: This file sets up configuration settings for the ALE plugin.
-" etc.
+"   Flags can be set in vimrc files and so on to disable particular features
 
 if exists('g:loaded_ale_flags')
     finish

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

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

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

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

stdin-wrapper

@@ -1,12 +1,12 @@
 #!/bin/bash -eu
 
-# This script implements a wrapper for any program which does not accept
+# 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.
 
+# All of the following arguments are read as command to run.
 file_extension="$1"
 shift