[libcalamares] Minor documentation on Yaml.*

src/libcalamares/utils/Yaml.cpp

@@ -1,7 +1,8 @@
 /* === This file is part of Calamares - <https://github.com/calamares> ===
- * 
+ *
  *   SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org>
  *   SPDX-FileCopyrightText: 2017-2018 Adriaan de Groot <groot@kde.org>
+ *   SPDX-License-Identifier: GPL-3.0-or-later
  *
  *
  *   Calamares is free software: you can redistribute it and/or modify
@@ -17,8 +18,6 @@
  *   You should have received a copy of the GNU General Public License
  *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
  *
- *   SPDX-License-Identifier: GPL-3.0-or-later
- *   License-Filename: LICENSE
  *
  */
 #include "Yaml.h"
@@ -125,7 +124,6 @@ yamlToStringList( const YAML::Node& listNode )
     return l;
 }
 
-
 void
 explainYamlException( const YAML::Exception& e, const QByteArray& yamlData, const char* label )
 {

src/libcalamares/utils/Yaml.h

@@ -1,7 +1,8 @@
 /* === This file is part of Calamares - <https://github.com/calamares> ===
- * 
+ *
  *   SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org>
  *   SPDX-FileCopyrightText: 2017-2018 Adriaan de Groot <groot@kde.org>
+ *   SPDX-License-Identifier: GPL-3.0-or-later
  *
  *
  *   Calamares is free software: you can redistribute it and/or modify
@@ -17,11 +18,16 @@
  *   You should have received a copy of the GNU General Public License
  *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
  *
- *   SPDX-License-Identifier: GPL-3.0-or-later
- *   License-Filename: LICENSE
  *
  */
 
+/*
+ * YAML conversions and YAML convenience header.
+ *
+ * Includes the system YAMLCPP headers without warnings (by switching off
+ * the expected warnings) and provides a handful of methods for
+ * converting between YAML and QVariant.
+ */
 #ifndef UTILS_YAML_H
 #define UTILS_YAML_H
 
@@ -50,7 +56,7 @@ class QFileInfo;
 #pragma clang diagnostic pop
 #endif
 
-/// @brief Appends all te elements of @p node to the string list @p v
+/// @brief Appends all the elements of @p node to the string list @p v
 void operator>>( const YAML::Node& node, QStringList& v );
 
 namespace CalamaresUtils