add some @deprecated in the documentation

This commit is contained in:
Marco Martin 2017-07-28 11:49:23 +02:00
parent 162431d793
commit dcf08486fe
9 changed files with 17 additions and 2 deletions

View File

@ -27,6 +27,11 @@ namespace Plasma
class Theme;
}
//TODO: should be possible to remove without significant breakages as is just an image provider
/**
* image provider for textures used for applications
* @deprecated don't use it
*/
class AppBackgroundProvider : public QQuickImageProvider
{

View File

@ -24,6 +24,10 @@
#include <QCache>
#include <QStringList>
/**
* Component that loads a qml file based on a chain of different fallback paths
* @deprecated this can be done with qmlregistertype on c++ side or a Loader on QML side
*/
class FallbackComponent : public QObject
{
Q_OBJECT

View File

@ -20,7 +20,6 @@
#include "plasmaextracomponentsplugin.h"
#include "appbackgroundprovider_p.h"
//#include "resourceinstance.h"
#include "fallbackcomponent.h"
#include <QtQml>
@ -38,7 +37,6 @@ void PlasmaExtraComponentsPlugin::initializeEngine(QQmlEngine *engine, const cha
void PlasmaExtraComponentsPlugin::registerTypes(const char *uri)
{
Q_ASSERT(uri == QLatin1String("org.kde.plasma.extras"));
//qmlRegisterType<ResourceInstance>(uri, 2, 0, "ResourceInstance");
qmlRegisterType<FallbackComponent>(uri, 2, 0, "FallbackComponent");
}

View File

@ -29,6 +29,7 @@ import org.kde.plasma.components 2.0 as PlasmaComponents
* to the device.
*
* @remark App is experimental, its API might change.
* @deprecated: use org.kde.kirigami ApplicationWindow or QtQuick.Controls 2.0 ApplicationWindow
*
* Example usage:
* @code

View File

@ -24,6 +24,7 @@ import QtQuick 2.0
* memory expensive) parts of the user interface load only when a certain
* condition is satisfied. For instance the contents of the tabs of a TabBar
* can be loaded only when they become the current page.
* @deprecated use a Loader instead
*/
FocusScope {
id: root

View File

@ -46,6 +46,9 @@ import org.kde.plasma.core 2.0 as PlasmaCore
import "../components/private/PageStack.js" as Engine
/**
* @deprecated use org.kde.kirigami PageRow instead
*/
Item {
id: actualRoot

View File

@ -41,6 +41,7 @@ import org.kde.plasma.components 2.0
*
* See PlasmaComponents Label and primitive QML Text element API for additional
* properties, methods and signals.
* @deprecated use QtQuickControls 2.0 Label instead
*/
Label {
id: paragraph

View File

@ -28,6 +28,7 @@ import QtQuick.Controls.Styles.Plasma 2.0 as Styles
* scrollbar will be a SectionScroller.
*
* See QtControls.ScrollView for full API
* TODO: soon to be deprecated after we can use QtQuickControls2 SvrollView instead (Qt 5.10)
*/
QtQuickControls.ScrollView {

View File

@ -39,6 +39,7 @@ import org.kde.plasma.components 2.0
*
* See PlasmaComponents Label and primitive QML Text element API for additional
* properties, methods and signals.
* @deprecated use org.kde.Kirigami.Heading instead
*/
Label {
id: root