napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libcalamares] Minor documentation on Yaml.*

Browse Source
This commit is contained in:
Adriaan de Groot 2020-07-09 10:45:28 +02:00
parent da1cc7c3a5
commit a58d59d86c
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/libcalamares/utils/Yaml.cpp
View File

@ -2,6 +2,7 @@
* *
* SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org> * SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org>
* SPDX-FileCopyrightText: 2017-2018 Adriaan de Groot <groot@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 * 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 * You should have received a copy of the GNU General Public License
* along with Calamares. If not, see <http://www.gnu.org/licenses/>. * 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" #include "Yaml.h"
@ -125,7 +124,6 @@ yamlToStringList( const YAML::Node& listNode )
return l; return l;
} }
void void
explainYamlException( const YAML::Exception& e, const QByteArray& yamlData, const char* label ) explainYamlException( const YAML::Exception& e, const QByteArray& yamlData, const char* label )
{ {

12
src/libcalamares/utils/Yaml.h
View File

@ -2,6 +2,7 @@
* *
* SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org> * SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org>
* SPDX-FileCopyrightText: 2017-2018 Adriaan de Groot <groot@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 * 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 * You should have received a copy of the GNU General Public License
* along with Calamares. If not, see <http://www.gnu.org/licenses/>. * 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 #ifndef UTILS_YAML_H
#define UTILS_YAML_H #define UTILS_YAML_H
@ -50,7 +56,7 @@ class QFileInfo;
#pragma clang diagnostic pop #pragma clang diagnostic pop
#endif #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 ); void operator>>( const YAML::Node& node, QStringList& v );
namespace CalamaresUtils namespace CalamaresUtils