diff --git a/CMakeLists.txt b/CMakeLists.txt --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -15,6 +15,14 @@ include(KDEFrameworkCompilerSettings NO_POLICY_SCOPE) include(KDECMakeSettings) include(ECMQtDeclareLoggingCategory) +include(ECMGenerateExportHeader) +include(ECMSetupVersion) +include(ECMGenerateHeaders) + +include(ECMAddQch) +include(ECMPoQmTools) + +set(EXCLUDE_DEPRECATED_BEFORE_AND_AT 0 CACHE STRING "Control the range of deprecated API excluded from the build [default=0].") set(REQUIRED_QT_VERSION 5.11.0) option(SONNET_USE_WIDGETS "Build components using Qt5Widgets" ON) @@ -24,14 +32,6 @@ find_package(Qt5 ${REQUIRED_QT_VERSION} CONFIG REQUIRED Core) -include(GenerateExportHeader) - -include(ECMSetupVersion) -include(ECMGenerateHeaders) - -include(ECMAddQch) -include(ECMPoQmTools) - ecm_setup_version(PROJECT VARIABLE_PREFIX SONNET VERSION_HEADER "${CMAKE_CURRENT_BINARY_DIR}/sonnet_version.h" PACKAGE_VERSION_FILE "${CMAKE_CURRENT_BINARY_DIR}/KF5SonnetConfigVersion.cmake" diff --git a/docs/Doxyfile.local b/docs/Doxyfile.local new file mode 100644 --- /dev/null +++ b/docs/Doxyfile.local @@ -0,0 +1,10 @@ +### KApiDox Project-specific Overrides File + +# define so that deprecated API is not skipped +PREDEFINED += \ + "SONNETCORE_ENABLE_DEPRECATED_SINCE(x, y)=1" \ + "SONNETCORE_BUILD_DEPRECATED_SINCE(x, y)=1" \ + "SONNETCORE_DEPRECATED_VERSION(x, y, t)=" \ + "SONNETUI_ENABLE_DEPRECATED_SINCE(x, y)=1" \ + "SONNETUI_BUILD_DEPRECATED_SINCE(x, y)=1" \ + "SONNETUI_DEPRECATED_VERSION(x, y, t)=" \ diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt --- a/src/core/CMakeLists.txt +++ b/src/core/CMakeLists.txt @@ -28,7 +28,16 @@ add_library(KF5SonnetCore ${sonnetcore_SRCS}) -generate_export_header(KF5SonnetCore BASE_NAME SonnetCore EXPORT_FILE_NAME sonnetcore_export.h) +ecm_generate_export_header(KF5SonnetCore + BASE_NAME SonnetCore + GROUP_BASE_NAME KF + VERSION ${KF5_VERSION} + DEPRECATED_BASE_VERSION 0 + #DEPRECATION_VERSIONS 5.65 + EXCLUDE_DEPRECATED_BEFORE_AND_AT ${EXCLUDE_DEPRECATED_BEFORE_AND_AT} +) + + add_library(KF5::SonnetCore ALIAS KF5SonnetCore) ecm_generate_headers(SonnetCore_CamelCase_HEADERS @@ -77,6 +86,7 @@ SONNETCORE_EXPORT SONNETCORE_DEPRECATED_EXPORT SONNETCORE_DEPRECATED + "SONNETCORE_DEPRECATED_VERSION(x, y, t)" TAGFILE_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} QCH_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} COMPONENT Devel diff --git a/src/ui/CMakeLists.txt b/src/ui/CMakeLists.txt --- a/src/ui/CMakeLists.txt +++ b/src/ui/CMakeLists.txt @@ -34,7 +34,15 @@ qt5_wrap_ui(sonnetui_SRCS ${sonnetui_UI}) add_library(KF5SonnetUi ${sonnetui_SRCS}) -generate_export_header(KF5SonnetUi BASE_NAME SonnetUi EXPORT_FILE_NAME sonnetui_export.h) +ecm_generate_export_header(KF5SonnetUi + BASE_NAME SonnetUi + GROUP_BASE_NAME KF + VERSION ${KF5_VERSION} + DEPRECATED_BASE_VERSION 0 + DEPRECATION_VERSIONS 5.65 + EXCLUDE_DEPRECATED_BEFORE_AND_AT ${EXCLUDE_DEPRECATED_BEFORE_AND_AT} +) + add_library(KF5::SonnetUi ALIAS KF5SonnetUi) target_link_libraries(KF5SonnetUi @@ -84,6 +92,7 @@ SONNETUI_EXPORT SONNETUI_DEPRECATED_EXPORT SONNETUI_DEPRECATED + "SONNETUI_DEPRECATED_VERSION(x, y, t)" TAGFILE_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} QCH_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} COMPONENT Devel diff --git a/src/ui/dialog.h b/src/ui/dialog.h --- a/src/ui/dialog.h +++ b/src/ui/dialog.h @@ -96,12 +96,21 @@ void setBuffer(const QString &); Q_SIGNALS: +#if SONNETUI_ENABLE_DEPRECATED_SINCE(5, 65) /** * The dialog won't be closed if you setBuffer() in slot connected to this signal - * * Also emitted after stop() signal + * @deprecated Since 5.65, use spellCheckDone */ + SONNETUI_DEPRECATED_VERSION(5, 65, "Use Dialog::spellCheckDone()") void done(const QString &newBuffer); +#endif + /** + * The dialog won't be closed if you setBuffer() in slot connected to this signal + * Also emitted after stop() signal + * @Since 5.65 + */ + void spellCheckDone(const QString &newBuffer); void misspelling(const QString &word, int start); void replace(const QString &oldWord, int start, const QString &newWord); diff --git a/src/ui/dialog.cpp b/src/ui/dialog.cpp --- a/src/ui/dialog.cpp +++ b/src/ui/dialog.cpp @@ -234,7 +234,10 @@ setProgressDialogVisible(false); emit stop(); //FIXME: should we emit done here? +#if SONNETUI_BUILD_DEPRECATED_SINCE(5, 65) emit done(d->checker->text()); +#endif + emit spellCheckDone(d->checker->text()); emit spellCheckStatus(tr("Spell check stopped.")); accept(); }