improved documentation, added version tag

Author: rubenphilipp

cologne-phonetics.lisp

@@ -1,17 +1,24 @@
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;; cologne-phonetics
+;;; FILE
+;;; cologne-phonetics.lisp
 ;;;
-;;; Purpose: Common Lisp implementation of the Cologne Phonetics algorithm
+;;; PURPOSE
+;;; Common Lisp implementation of the Cologne Phonetics algorithm
 ;;;
 ;;; Credits: This package is based on the Python implementation
 ;;;          by Janek Nouvertné
 ;;;          (https://github.com/provinzkraut/cologne_phonetics)
 ;;;
-;;; Author: Ruben Philipp <[email protected]>
+;;; AUTHOR
+;;; Ruben Philipp <[email protected]>
 ;;;
-;;; Creation date: 2023-02-01
+;;; CREATED
+;;; 2023-02-01
 ;;;
-;;; $$ Last modified:  22:13:51 Mon Mar 27 2023 CEST
+;;; VERSION
+;;; 1.0.1
+;;;
+;;; $$ Last modified:  11:02:00 Tue Mar 28 2023 CEST
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (in-package :cologne-phonetics)

example.lisp

@@ -1,11 +1,17 @@
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;; Filename: example.lisp
+;;; FILE
+;;; example.lisp
 ;;;
-;;; Purpose: examples usage
+;;; PURPOSE
+;;; Example for using the cologne-phonetics package.
 ;;;
-;;; Author: Ruben Philipp
-;;; Created: 2023-02-01
-;;; $$ Last modified:  15:10:32 Thu Feb  2 2023 CET
+;;; AUTHOR
+;;; Ruben Philipp
+;;;
+;;; CREATED
+;;; 2023-02-01
+;;;
+;;; $$ Last modified:  11:03:04 Tue Mar 28 2023 CEST
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (in-package :cl-user)
@@ -15,3 +21,6 @@
 
 
 (cologne-phonetics::encode "Philipp Philip Filip Filipp Fillipp")
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; EOF example.lisp

package.lisp

@@ -1,11 +1,20 @@
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;; filename: package.lisp
+;;; FILE
+;;; package.lisp
 ;;;
-;;; Purpose: definition of the cologne-phonetics package
+;;; PURPOSE
+;;; Definition of the cologne-phonetics package.
 ;;;
-;;; Author: Ruben Philipp <[email protected]>
-;;; Created: 2023-02-01, Essen
-;;; $$ Last modified:  20:08:20 Wed Feb  1 2023 CET
+;;; VERSION
+;;; 1.0.1
+;;;
+;;; AUTHOR
+;;; Ruben Philipp <[email protected]>
+;;;
+;;; CREATED
+;;; 2023-02-01, Essen
+;;;
+;;; $$ Last modified:  11:03:55 Tue Mar 28 2023 CEST
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (in-package :cl-user)
@@ -19,3 +28,6 @@
 (ql:quickload "split-sequence")
 
 (in-package :cologne-phonetics)
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; EOF package.lisp