From 51420ba4c733b140709b64a85b7914a67a9180d7 Mon Sep 17 00:00:00 2001
From: elektrischerwalfisch <mail@elektrischerwalfisch.de>
Date: Thu, 10 Apr 2025 22:54:06 +0200
Subject: [PATCH] adjust header-comments

---
 config-basic.php     | 15 +++++++--------
 config-multilang.php | 15 +++++++--------
 index.php            | 20 ++++++++++----------
 theme/css/style.css  |  9 ++++++++-
 theme/js/presets.js  |  7 +++++++
 theme/shortcodes.php |  6 ++++++
 6 files changed, 45 insertions(+), 27 deletions(-)

diff --git a/config-basic.php b/config-basic.php
index 9302b4e..cfed2d3 100644
--- a/config-basic.php
+++ b/config-basic.php
@@ -1,12 +1,11 @@
 <?php
-    /**
-     * Project: FlatMark
-     * File: config-basic.php
-     * Description: Configuration for a single-language setup (basic configuration).
-     * Author: elektrischerwalfisch
-     * License: MIT (or another open-source license)
-     * Version: 1.0
-     */
+/**
+ * Basic Configuration for flatMark
+ *
+ * Defines language and page loading behavior for single-language sites.
+ *
+ * @package flatMark
+ */
 
     // Define page language
         $lang = 'de';
diff --git a/config-multilang.php b/config-multilang.php
index 8223226..0fc9e37 100644
--- a/config-multilang.php
+++ b/config-multilang.php
@@ -1,12 +1,11 @@
 <?php 
-    /**
-     * Project: FlatMark
-     * File: config-multilang.php
-     * Description: Configuration for multilingual setup (supports multiple languages).
-     * Author: elektrischerwalfisch
-     * License: MIT (or another open-source license)
-     * Version: 1.0
-     */
+/**
+ * Multilingual configuration for flatMark
+ *
+ * Defines language and page loading behavior for multi-language sites.
+ *
+ * @package flatMark
+ */
 
     // Define supported languages (first one is default)
         $supportedLanguages = ['en', 'de'];     
diff --git a/index.php b/index.php
index 6886431..409c665 100644
--- a/index.php
+++ b/index.php
@@ -1,13 +1,13 @@
 <?php
-    /**
-     * Project: FlatMark
-     * File: index.php
-     * Description: Main entry point for the website. 
-     *              Dynamically loads Markdown content, basic or multilingual configuration and shortcode-settings.
-     * Author: elektrischerwalfisch
-     * License: MIT (or another open-source license)
-     * Version: 1.0
-     */
+/**
+ * Project: flatMark
+ * Version: 1.0
+ * 
+ * Project URI: https://github.com/elektrischerwalfisch/flatmark
+ * Author: elektrischerwalfisch
+ * Author URI: https://www.elektrischerwalfisch.de
+ * License: MIT (or another open-source license)
+ */
 
      // Start output buffering (prevents page to "jump" before everything is loaded)
         ob_start();
@@ -25,7 +25,7 @@
         $requestUri = trim($_SERVER['REQUEST_URI'], '/');
         $uriParts = explode('/', $requestUri);
 
-    // Multilingual setup. If your site is a single-language setup, change 'config-multilang.php' to 'config-basic.php'
+    // Multilingual setup. If your site is a single-language setup, change to 'config-basic.php'
         require 'config-multilang.php';
 
     // Read the content of the requested Markdown file into a string
diff --git a/theme/css/style.css b/theme/css/style.css
index 22b48b8..fbc2443 100644
--- a/theme/css/style.css
+++ b/theme/css/style.css
@@ -1,3 +1,10 @@
+/**
+* Stylesheet for flatMark theme
+* 
+* @package flatMark
+* @subpackage Theme
+*/
+     
 /* FONTS */
 
 @font-face {
@@ -132,7 +139,7 @@ h3 {font-size: var(--fontsize-l); font-weight: 700;}
 
 h2, h3, p, ul, ol {margin-bottom: var(--space-below-01);}
 
-a {color: var(--color-01); text-decoration: underline;}
+a {color: var(--color-02); text-decoration: underline;}
 a:hover {text-decoration: none;outline: 0;}
 ul {list-style: none;}
 img {border: none;max-width: 100%;height: auto;}
diff --git a/theme/js/presets.js b/theme/js/presets.js
index a3c46ac..c8c7047 100644
--- a/theme/js/presets.js
+++ b/theme/js/presets.js
@@ -1,3 +1,10 @@
+/**
+* JavaScript functions for flatMark theme
+* 
+* @package flatMark
+* @subpackage Theme
+*/
+
 document.addEventListener("DOMContentLoaded", function() {
     
 // HEADER: generate toggle-button, nav-wrapper and set variables
diff --git a/theme/shortcodes.php b/theme/shortcodes.php
index 181912c..afd66b2 100644
--- a/theme/shortcodes.php
+++ b/theme/shortcodes.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Shortcode definitions and handlers.
+ * 
+ * @package flatMark
+ * @subpackage Theme
+ */
 
     function processShortcodes($markdown) {
 
-- 
2.47.3