From 60c24d8a5ecc9a877c9a5c161a5e5e367bfa3c55 Mon Sep 17 00:00:00 2001
From: clerie <git@clerie.de>
Date: Sat, 19 Sep 2020 20:17:36 +0200
Subject: [PATCH] Comment functions

---
 js/reiseauskunft.js | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/js/reiseauskunft.js b/js/reiseauskunft.js
index daadcb6..9b48879 100644
--- a/js/reiseauskunft.js
+++ b/js/reiseauskunft.js
@@ -32,23 +32,42 @@ function bahnParseTrainName(dirty_train_name) {
   return dirty_train_name;
 }
 
+/**
+ * Returns HTML a as DOM object
+ *
+ * @param href URI as string
+ */
 function domCreateLink(href) {
   var link = document.createElement("a");
   link.setAttribute("href", href);
   return link;
 }
 
+/**
+ * Returns HTML img as DOM object
+ *
+ * @param src Image URI as string
+ */
 function domCreateImage(src) {
   var image = document.createElement("img");
   image.setAttribute("src", src);
   return image;
 }
 
+/**
+ * Returns HTML br as DOM object
+ */
 function domCreateLinebreak() {
   var linebreak = document.createElement("br");
   return linebreak;
 }
 
+/**
+ * Returns an 'image button' like construct as DOM object
+ *
+ * @param href URI as string
+ * @param image_src Image URI as string
+ */
 function domCreateButton(href, image_src) {
   var link = domCreateLink(href);
   link.setAttribute("target", "_blank");
@@ -58,6 +77,11 @@ function domCreateButton(href, image_src) {
   return link;
 }
 
+/**
+ * Returns an 'image buttom' to specifically link to marudor.de
+ *
+ * @param path URL path part after https://marudor.de
+ */
 function domCreateButtonMarudor(path) {
   var button = domCreateButton("https://marudor.de" + path, getMediaURL("marudor.svg"));
   return button;