Warning, /libraries/kweathercore/Mainpage.dox is written in an unsupported language. File is not indexed.
0001 /* 0002 * This file is part of KWeatherCore 0003 * SPDX-FileCopyrightText: 2020-2021 Han Young <hanyoung@protonmail.com> 0004 * 0005 * SPDX-License-Identifier: LGPL-2.0-or-later 0006 */ 0007 0008 0009 /** \mainpage kweathercore 0010 0011 0012 \section overview Introduction 0013 Get weather forecast and alerts anywhere on the earth easy. 0014 LibKWeather provides you a highly abstracted library for things related to weather. 0015 0016 \section components Main Components 0017 - \link KWeatherCore::WeatherForecastSource WeatherForecastSource \endlink 0018 - \link KWeatherCore::PendingWeatherForecast PendingWeatherForecast \endlink 0019 - \link KWeatherCore::SunriseSource SunriseSource \endlink 0020 - \link KWeatherCore::WeatherForecastSource WeatherForecastSource \endlink 0021 - \link KWeatherCore::LocationQuery LocationQuery \endlink 0022 - \link KWeatherCore::GeoTimezone GeoTimezone \endlink 0023 0024 \section example Minimal Example 0025 0026 @code 0027 #include <KWeatherCore/WeatherForecastSource> 0028 using namespace KWeatherCore; 0029 0030 //... 0031 0032 // Get the weatherforecast of Paris 0033 WeatherForecastSource m_source; 0034 0035 auto m_pendingForecast = m_source.requestData(48.86, 2.34); 0036 0037 connect(m_pendingForecast, &PendingWeatherForecast::finished, [m_pendingForecast]{auto m_weatherData = m_pendingForecast->value(); 0038 m_pendingForecast->deleteLater();}); 0039 connect(m_pendingForecast, &PendingWeatherForecast::networkError, []{qDebug() << "network error";}); 0040 0041 //... 0042 0043 @endcode 0044 0045 @authors 0046 Han Young \<hanyoung@protonmail.com\><br> 0047 Devin Lin \<espidev@gmail.com\><br> 0048 0049 @licenses 0050 @gpl 0051 0052 */ 0053 0054 0055 // DOXYGEN_SET_RECURSIVE = YES 0056 // DOXYGEN_SET_EXCLUDE_PATTERNS += *_p.h */private/* */examples/* */doc/* 0057 // DOXYGEN_SET_PROJECT_NAME = KWeatherCore 0058 // vim:ts=4:sw=4:expandtab:filetype=doxygen 0059