Skip to content
This repository has been archived by the owner on Dec 19, 2023. It is now read-only.

Commit

Permalink
Add documents
Browse files Browse the repository at this point in the history
  • Loading branch information
SineStriker committed Sep 3, 2023
1 parent dfa12a1 commit 4fc6bdc
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 13 deletions.
3 changes: 2 additions & 1 deletion doxygen/doxygen.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@ function(setup_doxygen_command _target)
endif()

add_custom_target(${_target}
${_build_command}
COMMAND ${CMAKE_COMMAND} -E make_directory ${_doxy_output_dir}
COMMAND ${_build_command}
COMMENT "Build HTML documentation"
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
VERBATIM
Expand Down
2 changes: 1 addition & 1 deletion doxygen/extra-stylesheet.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ table.memname tr {
}

.memname tr:last-child:not(:first-child) {
margin-left: 0.75em
margin-left: -0.75em
}
53 changes: 53 additions & 0 deletions src/core/framelesshelpercore_global.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,16 @@ void FramelessHelperCoreInitResource()
}
#endif // FRAMELESSHELPER_CONFIG(bundle_resource)

/*!
\namespace wangwenx190
\brief The author's root namespace.
*/

/*!
\namespace wangwenx190::FramelessHelper
\brief FramelessHelper namespace.
*/

FRAMELESSHELPER_BEGIN_NAMESPACE

#if FRAMELESSHELPER_CONFIG(debug_output)
Expand All @@ -122,8 +132,51 @@ FRAMELESSHELPER_BEGIN_NAMESPACE
# define CRITICAL QT_NO_QDEBUG_MACRO()
#endif

/*!
\namespace wangwenx190::FramelessHelper::Global
\brief FramelessHelper global namespace.
*/

using namespace Global;

/*!
\enum Global::Option
\brief FramelessHelper decoration options.
\var Global::Option::UseCrossPlatformQtImplementation
\brief Use pure Qt event system to emulate a frameless window.
\var Global::Option::ForceHideWindowFrameBorder
\brief Hide window frame border anyway.
\var Global::Option::ForceShowWindowFrameBorder
\brief Show window frame border anyway.
\var Global::Option::DisableWindowsSnapLayout
\brief Don't show snap layout, this option only works on Windows 11.
\var Global::Option::WindowUseRoundCorners
\brief Use round corners for windows anyway, this option only works on Windows 11.
\var Global::Option::CenterWindowBeforeShow
\brief Centralize the window before showing.
\var Global::Option::EnableBlurBehindWindow
\brief Show blur background.
\var Global::Option::ForceNonNativeBackgroundBlur
\brief Use non-native blur background anyway.
\var Global::Option::DisableLazyInitializationForMicaMaterial
\brief Disable lazy initialization for Mica Material.
\var Global::Option::ForceNativeBackgroundBlur
\brief Use native blur background anyway.
\var Global::Option::WindowUseSquareCorners
\brief Use square corners for windows anyway, this option only works on Windows 11.
*/

#ifdef Q_OS_WINDOWS
static_assert(std::size(WindowsVersions) == (static_cast<int>(WindowsVersion::Latest) + 1));
#endif
Expand Down
13 changes: 2 additions & 11 deletions src/core/framelessmanager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,6 @@ void FramelessManagerPrivate::initialize()
/*!
\class FramelessManager
\brief FramelessHelper global manager, managing all frameless related resources.
\property FramelessManager::systemTheme
\property FramelessManager::systemAccentColor
\property FramelessManager::wallpaper
\property FramelessManager::wallpaperAspectStyle
*/

FramelessManager::FramelessManager(QObject *parent) :
Expand Down Expand Up @@ -425,16 +420,12 @@ void FramelessManager::removeWindow(const WId windowId)

/*!
\fn void FramelessManager::systemThemeChanged()
This signal is emitted when the system theme changes externally.
\sa systemTheme()
\brief This signal is emitted when the system theme changes externally.
*/

/*!
\fn void FramelessManager::wallpaperChanged()
This signal is emitted when the system wallpaper changes externally.
\sa wallpaper()
\brief This signal is emitted when the system wallpaper changes externally.
*/

FRAMELESSHELPER_END_NAMESPACE

0 comments on commit 4fc6bdc

Please sign in to comment.