Skip to content

Commit

Permalink
Use cmakedoc project for doxygen and spellcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
mmertama committed Mar 8, 2024
1 parent 63b54c2 commit cbbd3ed
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 141 deletions.
19 changes: 13 additions & 6 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ cmake_minimum_required(VERSION 3.21)

project(FigmaQML LANGUAGES CXX)

include(FetchContent)

set(CMAKE_INCLUDE_CURRENT_DIR ON)

set(CMAKE_AUTOUIC ON)
Expand Down Expand Up @@ -108,7 +110,6 @@ add_compile_definitions(VERSION_NUMBER=${VERSION_NUMBER})
set(NON_SOURCE
todo.txt
README.md

.github/workflows/figmaqml.yml
)

Expand Down Expand Up @@ -153,7 +154,6 @@ endif()
option(QT6_CONCURRENT FALSE)
option(QT6_SSL FALSE)


if(HAS_QUL)
target_compile_definitions(${PROJECT_NAME} PRIVATE -DHAS_QUL)
endif()
Expand All @@ -168,22 +168,29 @@ set(COMMON_LIBS
FigmaQmlInterface
${EXTRA})

# Create documentation and do spellcheck in the Linux
if(LINUX AND NOT NO_DOC)
include(documentation.cmake)
set(DOCUMENTATION_DOXYGEN_DOCUMENTS
FetchContent_Declare(
cmakedoc
GIT_REPOSITORY https://github.com/mmertama/cmakedoc.git
GIT_TAG main
)
FetchContent_MakeAvailable(cmakedoc)
include(${cmakedoc_SOURCE_DIR}/cmakedoc.cmake)
set(CMAKEDOC_DOXYGEN_DOCUMENTS
app_figma/FigmaQmlInterface/FigmaQmlInterface.hpp
mcu_figma/FigmaQmlInterface/FigmaQmlInterface.hpp
)
add_doxygen(${PROJECT_NAME})
set(DOCUMENTATION_SPELL_EXCLUDE_DIRS
set(CMAKEDOC_SPELL_EXCLUDE_DIRS
build
aspell
modules
res
.git
FigmaQML
OpenSSL*)
set(DOCUMENTATION_SPELL_EXCLUDE_FILES
set(CMAKEDOC_SPELL_EXCLUDE_FILES
\*.qmlproject*)
add_spellcheck(${PROJECT_NAME})
endif()
Expand Down
4 changes: 3 additions & 1 deletion app_figma/FigmaQmlInterface/FigmaQmlInterface.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ class FigmaQmlSingleton : public QObject {
Q_OBJECT
QML_ELEMENT
QML_SINGLETON
/// Name of currently active view
Q_PROPERTY(QString currentView MEMBER m_currentView NOTIFY currentViewChanged)
/// Number of views
Q_PROPERTY(int viewCount READ viewCount() CONSTANT)
public:
/**
Expand All @@ -33,7 +35,7 @@ class FigmaQmlSingleton : public QObject {
signals:
/// @brief emitted on applyValue
/// @param element
/// @param source
/// @param value
void valueChanged(const QString& element, const QString& value);
/// @brief emitted for asLoader source change
/// @param element
Expand Down
134 changes: 0 additions & 134 deletions documentation.cmake

This file was deleted.

0 comments on commit cbbd3ed

Please sign in to comment.