Skip to content

Commit

Permalink
Convert documentation from qtdoc to Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
plfiorini committed Oct 22, 2024
1 parent fa07388 commit c4c8a61
Show file tree
Hide file tree
Showing 18 changed files with 49 additions and 541 deletions.
5 changes: 1 addition & 4 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ include(ECMQmlModule)
## Features:
include(features.cmake)

## Project setup:
qt6_standard_project_setup(REQUIRES 6.6)

## Disable use of C++ API deprecated in Qt 5.15
add_compile_definitions(QT_DISABLE_DEPRECATED_UP_TO=0x050F00)

Expand All @@ -43,7 +40,7 @@ endif()

## Add subdirectories:
if(FLUID_WITH_DOCUMENTATION)
#add_subdirectory(doc)
add_subdirectory(doc)
endif()
if(FLUID_WITH_QML_MODULES)
add_subdirectory(src/imports/controls)
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Qt >= 6.6.0 with at least the following modules is required:
* [qtquickcontrols2](http://code.qt.io/cgit/qt/qtquickcontrols2.git)
* [qtgraphicaleffects](http://code.qt.io/cgit/qt/qtgraphicaleffects.git)
* [qtsvg](http://code.qt.io/cgit/qt/qtsvg.git)
* [qtdoc](http://code.qt.io/cgit/qt/qtdoc.git)

On Linux you also need:

Expand Down
40 changes: 22 additions & 18 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
include(LiriQDoc)
if(DOXYGEN_FOUND)
# Set the output directory for Doxygen documentation
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/output)

if(Qt5Core_VERSION VERSION_GREATER_EQUAL "5.12.0")
set(_qtquickcontrols_name "qtquickcontrols")
else()
set(_qtquickcontrols_name "qtquickcontrols2")
endif()
# Ensure the output directory exists
#file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})

# Configure Doxyfile
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
@ONLY
)

# Doxygen custom targets
add_custom_target(doc_doxygen ALL
COMMAND ${CMAKE_COMMAND} -E make_directory ${DOXYGEN_OUTPUT_DIR}
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
COMMENT "Generating Doxygen documentation" VERBATIM
)

liri_install_doc(
"${CMAKE_CURRENT_SOURCE_DIR}/fluid.qdocconf"
OUTPUT_DIRECTORY_VARIABLE
_doc_output_dir
ENVIRONMENT
QTQUICKCONTROLS_NAME="${_qtquickcontrols_name}"
FLUID_VERSION="${PROJECT_VERSION}"
FLUID_VERSION_TAG="${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
FLUID_BUILD_DIR="${CMAKE_CURRENT_BINARY_DIR}"
)
if(_doc_output_dir)
install(DIRECTORY "${_doc_output_dir}/" DESTINATION "${INSTALL_DOCDIR}/fluid/html")
install(DIRECTORY ${DOXYGEN_OUTPUT_DIR}/
DESTINATION ${KDE_INSTALL_DATADIR}/doc/${PROJECT_NAME})
endif()
11 changes: 11 additions & 0 deletions doc/Doxyfile.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
INPUT = ../src/imports
OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIR@
RECURSIVE = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_METHODS = YES
FILE_PATTERNS = *.qml *.cpp *.h
ENABLE_PREPROCESSING = YES
HAVE_DOT = YES
CLASS_DIAGRAMS = YES
59 changes: 0 additions & 59 deletions doc/config/fluid-project.qdocconf

This file was deleted.

2 changes: 0 additions & 2 deletions doc/config/macros.qdocconf

This file was deleted.

67 changes: 0 additions & 67 deletions doc/fluid.qdocconf

This file was deleted.

34 changes: 0 additions & 34 deletions doc/src/fluidcontrols-qmltypes.qdoc

This file was deleted.

34 changes: 0 additions & 34 deletions doc/src/fluidcore-qmltypes.qdoc

This file was deleted.

40 changes: 0 additions & 40 deletions doc/src/fluidtemplates-qmltypes.qdoc

This file was deleted.

42 changes: 0 additions & 42 deletions doc/src/index.qdoc

This file was deleted.

Loading

0 comments on commit c4c8a61

Please sign in to comment.