Skip to content

Commit 20c4a1b

Browse files
committed
clear header
* make the commentary part cleaner * add a elixir-mode information group
1 parent 9928e74 commit 20c4a1b

File tree

1 file changed

+11
-101
lines changed

1 file changed

+11
-101
lines changed

elixir-mode.el

Lines changed: 11 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -30,106 +30,8 @@
3030

3131
;;; Commentary:
3232

33-
;; Provides font-locking, indentation and navigation support
34-
;; for the Elixir programming language.
35-
;;
36-
;;
37-
;; Manual Installation:
38-
;;
39-
;; (add-to-list 'load-path "~/path/to/emacs-elixir/")
40-
;; (require 'elixir-mode)
41-
;;
42-
;; Interesting variables are:
43-
;;
44-
;; `elixir-compiler-command`
45-
;;
46-
;; Path to the executable <elixirc> command
47-
;;
48-
;; `elixir-iex-command`
49-
;;
50-
;; Path to the executable <iex> command
51-
;;
52-
;; `elixir-mode-cygwin-paths`
53-
;;
54-
;; Use Cygwin style paths on Windows operating systems.
55-
;;
56-
;; `elixir-mode-cygwin-prefix`
57-
;;
58-
;; Cygwin prefix
59-
;;
60-
;; Major commands are:
61-
;;
62-
;; M-x elixir-mode
63-
;;
64-
;; Switches to elixir-mode.
65-
;;
66-
;; M-x elixir-cos-mode
67-
;;
68-
;; Applies compile-on-save minor mode.
69-
;;
70-
;; M-x elixir-mode-compile-file
71-
;;
72-
;; Compile and save current file.
73-
;;
74-
;; M-x elixir-mode-iex
75-
;;
76-
;; Launch <iex> inside Emacs.
77-
;; Use "C-u" (universal-argument) to run <iex> with some additional arguments.
78-
;;
79-
;; M-x elixir-mode-eval-on-region
80-
;;
81-
;; Evaluates the Elixir code on the marked region.
82-
;; This is bound to "C-c ,r" while in `elixir-mode'.
83-
;;
84-
;; M-x elixir-mode-eval-on-current-line
85-
;;
86-
;; Evaluates the Elixir code on the current line.
87-
;; This is bound to "C-c ,c" while in `elixir-mode'.
88-
;;
89-
;; M-x elixir-mode-eval-on-current-buffer
90-
;;
91-
;; Evaluates the Elixir code on the current buffer.
92-
;; This is bound to "C-c ,b" while in `elixir-mode'.
93-
;;
94-
;; M-x elixir-mode-string-to-quoted-on-region
95-
;;
96-
;; Get the representation of the expression on the marked region.
97-
;; This is bound to "C-c ,a" while in `elixir-mode'.
98-
;;
99-
;; M-x elixir-mode-string-to-quoted-on-current-line
100-
;;
101-
;; Get the representation of the expression on the current line.
102-
;; This is bound to "C-c ,l" while in `elixir-mode'.
103-
;;
104-
;; M-x elixir-mode-opengithub
105-
;;
106-
;; Open the GitHub page of the Elixir repository.
107-
;;
108-
;; M-x elixir-mode-open-elixir-home
109-
;;
110-
;; Open the Elixir website.
111-
;;
112-
;; M-x elixir-mode-open-docs-master
113-
;;
114-
;; Open the Elixir documentation for the master.
115-
;;
116-
;; M-x elixir-mode-open-docs-stable
117-
;;
118-
;; Open the Elixir documentation for the latest stable release.
119-
;;
120-
;; M-x elixir-mode-show-version
121-
;;
122-
;; Print `elixir-mode` version.
123-
;;
124-
;; Also check out the customization group
125-
;;
126-
;; M-x customize-group RET elixir RET
127-
;;
128-
;; If you use the customization group to set variables like
129-
;; `elixir-compiler-command' or `elixir-iex-command', make sure the path to
130-
;; "elixir-mode.el" is present in the `load-path' *before* the
131-
;; `custom-set-variables' is executed in your .emacs file.
132-
;;
33+
;; Provides font-locking, indentation and navigation support
34+
;; for the Elixir programming language.
13335

13436
;;; Code:
13537

@@ -139,7 +41,15 @@
13941
(require 'elixir-smie) ; syntax and indentation support
14042
(require 'elixir-deprecated) ; deprecated messages
14143

142-
(defvar elixir-mode--website-url
44+
(defgroup elixir-mode nil
45+
"Provides font-locking, indentation and navigation support
46+
for the Elixir programming language."
47+
:prefix "elixir-mode-"
48+
:group 'applications
49+
:link '(url-link :tag "Github" "https://github.com/elixir-lang/emacs-elixir")
50+
:link '(emacs-commentary-link :tag "Commentary" "elixir-mode"))
51+
52+
(defvar elixir-mqode--website-url
14353
"http://elixir-lang.org")
14454

14555
(defvar elixir-mode-hook nil)

0 commit comments

Comments
 (0)