mirror of
https://github.com/QuasarApp/Patronum.git
synced 2025-04-29 17:14:32 +00:00
fix documentation
This commit is contained in:
parent
a8709667b2
commit
6d6842b747
@ -12,10 +12,12 @@ if(TARGET ${PROJECT_NAME})
|
|||||||
return()
|
return()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
include(Patronum/qt-solutions/CMake/ccache.cmake)
|
include(Patronum/QuasarAppLib/CMake/ccache.cmake)
|
||||||
# Add sub directories
|
# Add sub directories
|
||||||
add_subdirectory(Patronum)
|
add_subdirectory(Patronum)
|
||||||
|
|
||||||
include(Patronum/qt-solutions/CMake/QuasarAppCITargets.cmake)
|
include(Patronum/QuasarAppLib/CMake/QuasarAppCITargets.cmake)
|
||||||
|
|
||||||
|
addDoc("Patronum" ${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf)
|
||||||
|
|
||||||
initAll()
|
initAll()
|
||||||
|
@ -16,8 +16,8 @@ endif()
|
|||||||
add_subdirectory(qt-solutions/qtservice)
|
add_subdirectory(qt-solutions/qtservice)
|
||||||
add_subdirectory(QuasarAppLib)
|
add_subdirectory(QuasarAppLib)
|
||||||
|
|
||||||
include(qt-solutions/CMake/ProjectOut.cmake)
|
include(QuasarAppLib/CMake/ProjectOut.cmake)
|
||||||
include(qt-solutions/CMake/Version.cmake)
|
include(QuasarAppLib/CMake/Version.cmake)
|
||||||
|
|
||||||
|
|
||||||
set(CMAKE_INCLUDE_CURRENT_DIR ON)
|
set(CMAKE_INCLUDE_CURRENT_DIR ON)
|
||||||
|
@ -10,9 +10,9 @@ class ControllerPrivate;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief The Controller class provide control functionality for your service
|
* @brief The Controller class provide control functionality for your service
|
||||||
* how to use :
|
* ###How to use :
|
||||||
* just inherit from the Service Controller and override the methods you need.
|
* - just inherit from the Service Controller and override the methods you need.
|
||||||
* So, invoke the send methon, and if you need to get a responce from your service then invoke a waitForResponce method.
|
* - So, invoke the send methon, and if you need to get a responce from your service then invoke a waitForResponce method.
|
||||||
*/
|
*/
|
||||||
class PATRONUM_LIBRARYSHARED_EXPORT Controller : public QtServiceController, protected IController
|
class PATRONUM_LIBRARYSHARED_EXPORT Controller : public QtServiceController, protected IController
|
||||||
{
|
{
|
||||||
|
@ -9,9 +9,8 @@
|
|||||||
namespace Patronum {
|
namespace Patronum {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief The Feature class - it is atomic type for describe service command
|
* @brief The Feature class it is atomic type for describe service command
|
||||||
*/
|
*/
|
||||||
|
|
||||||
class PATRONUM_LIBRARYSHARED_EXPORT Feature
|
class PATRONUM_LIBRARYSHARED_EXPORT Feature
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
@ -9,12 +9,12 @@
|
|||||||
|
|
||||||
namespace Patronum {
|
namespace Patronum {
|
||||||
|
|
||||||
/**
|
|
||||||
* Service -
|
|
||||||
* How to use
|
|
||||||
* just inherit from the Service class and override the methods you need.
|
|
||||||
*/
|
|
||||||
template<class Application>
|
template<class Application>
|
||||||
|
/**
|
||||||
|
* @brief The Service class it is class for create a services from daemons.
|
||||||
|
* ###How to use :
|
||||||
|
* - just inherit from the Service class and override the methods you need.
|
||||||
|
*/
|
||||||
class PATRONUM_LIBRARYSHARED_EXPORT Service : public QtService<Application>, protected IService
|
class PATRONUM_LIBRARYSHARED_EXPORT Service : public QtService<Application>, protected IService
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
@ -4,5 +4,8 @@
|
|||||||
#include "PController.h"
|
#include "PController.h"
|
||||||
#include "PService.h"
|
#include "PService.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief The Patronum namespace - it is main name space of Patronum Library
|
||||||
|
*/
|
||||||
namespace Patronum {}
|
namespace Patronum {}
|
||||||
#endif // PATRONUM_H
|
#endif // PATRONUM_H
|
||||||
|
Loading…
x
Reference in New Issue
Block a user