Documentation of function and version bump to 0.2

Author: AdrieanKhisbe

fireplace.el

@@ -1,7 +1,7 @@
 ;;; fireplace.el --- A cozy fireplace for emacs      -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2015 Johan Sivertsen
-;;; Version: 0.1
+;;; Version: 0.2
 ;;; Author: Johan Sivertsen <[email protected]>
 ;;; URL: https://github.com/johanvts/emacs-fireplace
 ;;; Released: December 2015
@@ -23,7 +23,7 @@
 
 ;;; Commentary:
 
-;; Puts your emacs on fire
+;; Puts your Emacs on fire
 
 ;;; Code:
 
@@ -72,16 +72,20 @@
 ;; Helper routines
 
 (defun fireplace--make-grid ()
+  "Redraw backgound of buffer."
   (erase-buffer)
   (dotimes (i fireplace--bkgd-height)
     (insert-char fireplace-background-char fireplace--bkgd-width)
     (newline)))
 
 (defun fireplace--gotoxy(x y)
-  (goto-char (+ 1 x (* (- fireplace--bkgd-height (+ 1 y)) (+ 1 fireplace--bkgd-width)))))
+  "Move pointer to position X Y."
+  (goto-char (+ 1 x (* (- fireplace--bkgd-height (+ 1 y))
+                       (+ 1 fireplace--bkgd-width)))))
 
 
 (defun draw-flame-stripe (x y width)
+  "Draw fire stripes."
   (fireplace--gotoxy x y)
   (let* ((actual-width (min width (1+ (- fireplace--bkgd-width x))))
 	 (hot-core (/ actual-width 2)))
@@ -95,6 +99,7 @@
 				      'face `(:background ,"dark orange"))))))
 
 (defun fireplace--smoke (x height)
+  "Draw fire smoke."
   (fireplace--gotoxy (if (>(random 3) 1)
         (+ x (random (/ fireplace--bkgd-width 5)))
       (max 0 (- x (random (/ fireplace--bkgd-width 5)))))
@@ -104,6 +109,7 @@
 		      'face `(:foreground, "slate grey"))))
 
 (defun fireplace--flame (middle h)
+  "Draw fire flames."
   (setq cursor-type nil)
   (let* ((width h)
 	 (lower (truncate(* 0.2 h)))
@@ -132,6 +138,7 @@
       (when fireplace-smoke-on (fireplace--smoke x h)))))
 
 (defun draw-fireplace (buffer-name flame-pos flame-width)
+  "Draw the whole fireplace in BUFFER-NAME from FLAME-POS with FLAME-WIDTH."
   (with-current-buffer (get-buffer-create buffer-name)
     (setq buffer-read-only nil)
     (fireplace--make-grid)
@@ -169,26 +176,26 @@
     (kill-buffer fireplace-buffer-name)))
 
 (defun fireplace-down ()
-  (interactive)
   "Push the fire further down"
+  (interactive)
   (setq fireplace--bkgd-height (+ fireplace--bkgd-height 1)))
 
 
 (defun fireplace-up ()
+  "Move the fire further up."
   (interactive)
-  "Move the fire further up"
   (setq fireplace--bkgd-height (max 0 (- fireplace--bkgd-height 1))))
 
 (defun fireplace-toggle-smoke ()
+  "Toggle smoke on/off."
   (interactive)
-  "Toggle smoke on/off"
   (if fireplace-smoke-on
       (setq fireplace-smoke-on nil)
     (setq fireplace-smoke-on t)))
 
-;;Key-bindings
+;;; Key-bindings
 
-(define-derived-mode fireplace-mode special-mode  "A cozy fireplace")
+(define-derived-mode fireplace-mode special-mode  "A cozy fireplace.")
 
 (define-key fireplace-mode-map (kbd "C-+") 'fireplace-down)
 (define-key fireplace-mode-map (kbd "C--") 'fireplace-up)