From 682146aa9b9d5267b379c6144c0454caa462594e Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Thu, 9 Jul 2020 16:08:51 +0200 Subject: [PATCH] [libcalamares] Expand dox on TimeZone pairs --- src/libcalamares/locale/TimeZone.h | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/src/libcalamares/locale/TimeZone.h b/src/libcalamares/locale/TimeZone.h index 60900ef21..05820817a 100644 --- a/src/libcalamares/locale/TimeZone.h +++ b/src/libcalamares/locale/TimeZone.h @@ -1,6 +1,7 @@ /* === This file is part of Calamares - === - * + * * SPDX-FileCopyrightText: 2019 Adriaan de Groot + * SPDX-License-Identifier: GPL-3.0-or-later * * Calamares is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -15,8 +16,6 @@ * You should have received a copy of the GNU General Public License * along with Calamares. If not, see . * - * SPDX-License-Identifier: GPL-3.0-or-later - * License-Filename: LICENSE * */ @@ -88,7 +87,13 @@ public: } }; -/// @brief A pair of strings for timezone regions (e.g. "America") +/** @brief Timezone regions (e.g. "America") + * + * A region has a key and a human-readable name, but also + * a collection of associated timezone zones (TZZone, below). + * This class is not usually constructed, but uses fromFile() + * to load a complete tree structure of timezones. + */ class TZRegion : public CStringPair { Q_OBJECT @@ -120,7 +125,12 @@ private: CStringPairList m_zones; }; -/// @brief A pair of strings for specific timezone names (e.g. "New_York") +/** @brief Specific timezone zones (e.g. "New_York", "New York") + * + * A timezone zone lives in a region, and has some associated + * data like the country (used to map likely languages) and latitude + * and longitude information. + */ class TZZone : public CStringPair { Q_OBJECT