remove all useless header comments (#3363)

see #3358 used command: `find ./ -type f -exec perl -i -0pe 's/\/\*\s*magicmirror.*?\*\/\s*//si' {} \;` This is a first draft, I think we should preserve some of the comments.
2025-08-22 13:09:26 +00:00 · 2024-01-24 21:39:06 +01:00
parent b0161fe011
commit 27f3c86c41
108 changed files with 30 additions and 623 deletions
--- a/modules/default/weather/providers/envcanada.js
+++ b/modules/default/weather/providers/envcanada.js
@@ -1,10 +1,6 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */

-/* MagicMirror²
- * Module: Weather
- * Provider: Environment Canada (EC)
- *
- * This class is a provider for Environment Canada MSC Datamart
+/* This class is a provider for Environment Canada MSC Datamart
 * Note that this is only for Canadian locations and does not require an API key (access is anonymous)
 *
 * EC Documentation at following links:
@@ -27,8 +23,6 @@
 * with locations you can search under column B (English Names), with the corresponding siteCode under
 * column A (Codes) and provCode under column C (Province).
 *
- * Original by Kevin Godin
- *
 * License to use Environment Canada (EC) data is detailed here:
 * 	https://eccc-msc.github.io/open-data/licence/readme_en/
 *
--- a/modules/default/weather/providers/openmeteo.js
+++ b/modules/default/weather/providers/openmeteo.js
@@ -1,15 +1,9 @@
 /* global WeatherProvider, WeatherObject */

-/* MagicMirror²
- * Module: Weather
- * Provider: Open-Meteo
- *
- * By Andrés Vanegas
- * MIT Licensed
- *
- * This class is a provider for Open-Meteo, based on Andrew Pometti's class
- * for Weatherbit.
+/* This class is a provider for Open-Meteo,
+ * see https://open-meteo.com/
 */
+
 // https://www.bigdatacloud.com/docs/api/free-reverse-geocode-to-city-api
 const GEOCODE_BASE = "https://api.bigdatacloud.net/data/reverse-geocode-client";
 const OPEN_METEO_BASE = "https://api.open-meteo.com/v1";
--- a/modules/default/weather/providers/openweathermap.js
+++ b/modules/default/weather/providers/openweathermap.js
@@ -1,12 +1,7 @@
 /* global WeatherProvider, WeatherObject */

-/* MagicMirror²
- * Module: Weather
- *
- * By Michael Teeuw https://michaelteeuw.nl
- * MIT Licensed.
- *
- * This class is the blueprint for a weather provider.
+/* This class is a provider for Openweathermap,
+ * see https://openweathermap.org/
 */
 WeatherProvider.register("openweathermap", {
 	// Set the name of the provider.
--- a/modules/default/weather/providers/pirateweather.js
+++ b/modules/default/weather/providers/pirateweather.js
@@ -1,14 +1,7 @@
 /* global WeatherProvider, WeatherObject */

-/* MagicMirror²
- * Module: Weather
- * Provider: Pirate Weather
- *
- * Written by Nicholas Hubbard https://github.com/nhubbard for formerly Dark Sky Provider
- * Modified by Karsten Hassel for Pirate Weather
- * MIT Licensed
- *
- * This class is a provider for Pirate Weather, it is a replacement for Dark Sky (same api).
+/* This class is a provider for Pirate Weather, it is a replacement for Dark Sky (same api),
+ * see http://pirateweather.net/en/latest/
 */
 WeatherProvider.register("pirateweather", {
 	// Set the name of the provider.
--- a/modules/default/weather/providers/smhi.js
+++ b/modules/default/weather/providers/smhi.js
@@ -1,14 +1,8 @@
 /* global WeatherProvider, WeatherObject */

-/* MagicMirror²
- * Module: Weather
- * Provider: SMHI
- *
- * By BuXXi https://github.com/buxxi
- * MIT Licensed
- *
- * This class is a provider for SMHI (Sweden only). Metric system is the only
- * supported unit.
+/* This class is a provider for SMHI (Sweden only).
+ * Metric system is the only supported unit,
+ * see https://www.smhi.se/
 */
 WeatherProvider.register("smhi", {
 	providerName: "SMHI",
--- a/modules/default/weather/providers/ukmetoffice.js
+++ b/modules/default/weather/providers/ukmetoffice.js
@@ -1,12 +1,7 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */

-/* MagicMirror²
- * Module: Weather
- *
- * By Malcolm Oakes https://github.com/maloakes
- * MIT Licensed.
- *
- * This class is a provider for UK Met Office Datapoint.
+/* This class is a provider for UK Met Office Datapoint,
+ * see https://www.metoffice.gov.uk/
 */
 WeatherProvider.register("ukmetoffice", {
 	// Set the name of the provider.
--- a/modules/default/weather/providers/ukmetofficedatahub.js
+++ b/modules/default/weather/providers/ukmetofficedatahub.js
@@ -1,13 +1,6 @@
 /* global WeatherProvider, WeatherObject */

-/* MagicMirror²
- * Module: Weather
- *
- * By Malcolm Oakes https://github.com/maloakes
- * Existing Met Office provider edited for new MetOffice Data Hub by CreepinJesus http://github.com/XBCreepinJesus
- * MIT Licensed.
- *
- * This class is a provider for UK Met Office Data Hub (the replacement for their Data Point services).
+/* This class is a provider for UK Met Office Data Hub (the replacement for their Data Point services).
 * For more information on Data Hub, see https://www.metoffice.gov.uk/services/data/datapoint/notifications/weather-datahub
 * Data available:
 * 		Hourly data for next 2 days ("hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-hourly.pdf
--- a/modules/default/weather/providers/weatherbit.js
+++ b/modules/default/weather/providers/weatherbit.js
@@ -1,14 +1,7 @@
 /* global WeatherProvider, WeatherObject */

-/* MagicMirror²
- * Module: Weather
- * Provider: Weatherbit
- *
- * By Andrew Pometti
- * MIT Licensed
- *
- * This class is a provider for Weatherbit, based on Nicholas Hubbard's class
- * for Dark Sky & Vince Peri's class for Weather.gov.
+/* This class is a provider for Weatherbit,
+ * see https://www.weatherbit.io/
 */
 WeatherProvider.register("weatherbit", {
 	// Set the name of the provider.
--- a/modules/default/weather/providers/weatherflow.js
+++ b/modules/default/weather/providers/weatherflow.js
@@ -1,16 +1,8 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */

-/* MagicMirror²
- * Module: Weather
- * Provider: Weatherflow
- *
- * By Tobias Dreyem https://github.com/10bias
- * MIT Licensed
- *
- * This class is a provider for Weatherflow.
+/* This class is a provider for Weatherflow.
 * Note that the Weatherflow API does not provide snowfall.
 */
-
 WeatherProvider.register("weatherflow", {
 	// Set the name of the provider.
 	// Not strictly required, but helps for debugging
--- a/modules/default/weather/providers/weathergov.js
+++ b/modules/default/weather/providers/weathergov.js
@@ -1,13 +1,8 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */

-/* MagicMirror²
- * Module: Weather
- * Provider: weather.gov
+/* Provider: weather.gov
 * https://weather-gov.github.io/api/general-faqs
 *
- * Original by Vince Peri
- * MIT Licensed.
- *
 * This class is a provider for weather.gov.
 * Note that this is only for US locations (lat and lon) and does not require an API key
 * Since it is free, there are some items missing - like sunrise, sunset
--- a/modules/default/weather/providers/yr.js
+++ b/modules/default/weather/providers/yr.js
@@ -1,14 +1,6 @@
 /* global WeatherProvider, WeatherObject */

-/* MagicMirror²
- * Module: Weather
- * Provider: Yr.no
- *
- * By Magnus Marthinsen
- * MIT Licensed
- *
- * This class is a provider for Yr.no, a norwegian weather service.
- *
+/* This class is a provider for Yr.no, a norwegian weather service.
 * Terms of service: https://developer.yr.no/doc/TermsOfService/
 */
 WeatherProvider.register("yr", {
--- a/modules/default/weather/weather.js
+++ b/modules/default/weather/weather.js
@@ -1,11 +1,5 @@
 /* global WeatherProvider, WeatherUtils, formatTime */

-/* MagicMirror²
- * Module: Weather
- *
- * By Michael Teeuw https://michaelteeuw.nl
- * MIT Licensed.
- */
 Module.register("weather", {
 	// Default module config.
 	defaults: {
--- a/modules/default/weather/weatherobject.js
+++ b/modules/default/weather/weatherobject.js
@@ -1,17 +1,5 @@
 /* global SunCalc, WeatherUtils */

-/* MagicMirror²
- * Module: Weather
- *
- * By Michael Teeuw https://michaelteeuw.nl
- * MIT Licensed.
- *
- * This class is the blueprint for a day which includes weather information.
- *
- * Currently this is focused on the information which is necessary for the current weather.
- * As soon as we start implementing the forecast, mode properties will be added.
- */
-
 /**
 * @external Moment
 */
--- a/modules/default/weather/weatherprovider.js
+++ b/modules/default/weather/weatherprovider.js
@@ -1,13 +1,6 @@
 /* global Class, performWebRequest, OverrideWrapper */

-/* MagicMirror²
- * Module: Weather
- *
- * By Michael Teeuw https://michaelteeuw.nl
- * MIT Licensed.
- *
- * This class is the blueprint for a weather provider.
- */
+// This class is the blueprint for a weather provider.
 const WeatherProvider = Class.extend({
 	// Weather Provider Properties
 	providerName: null,
--- a/modules/default/weather/weatherutils.js
+++ b/modules/default/weather/weatherutils.js
@@ -1,9 +1,3 @@
-/* MagicMirror²
- * Weather Util Methods
- *
- * By Rejas
- * MIT Licensed.
- */
 const WeatherUtils = {

 	/**