diff --git a/CoreUI/Bundles/org.mitk.core.services/documentation/doxygen/modules.dox b/CoreUI/Bundles/org.mitk.core.services/documentation/doxygen/modules.dox new file mode 100755 index 0000000000..9ce368e6d1 --- /dev/null +++ b/CoreUI/Bundles/org.mitk.core.services/documentation/doxygen/modules.dox @@ -0,0 +1,16 @@ +/** + \defgroup org_mitk_core_services org.mitk.core.services + \ingroup MITKPlugins + + \brief Provides basic MITK services. + +*/ + +/** + \defgroup org_mitk_core_services_internal Internal + \ingroup org_mitk_core_services + + \brief This subcategory includes the internal classes of the org.mitk.core.services plugin. Other + plugins must not rely on these classes. They contain implementation details and their interface + may change at any time. We mean it. +*/ diff --git a/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageReference.h b/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageReference.h index 7458357b82..5a681dabf1 100644 --- a/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageReference.h +++ b/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageReference.h @@ -1,48 +1,51 @@ /*========================================================================= Program: Medical Imaging & Interaction Toolkit Language: C++ Date: $Date$ Version: $Revision$ Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. See MITKCopyright.txt or http://www.mitk.org/copyright.html for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the above copyright notices for more information. =========================================================================*/ #ifndef MITKIDATASTORAGEREFERENCE_H_ #define MITKIDATASTORAGEREFERENCE_H_ #include #include #include #include namespace mitk { +/** + * \ingroup org_mitk_core_services + */ struct MITK_CORE_SERVICES_PLUGIN IDataStorageReference : public berry::Object { berryInterfaceMacro(IDataStorageReference, mitk); virtual DataStorage::Pointer GetDataStorage() const = 0; virtual bool IsDefault() const = 0; virtual QString GetLabel() const = 0; virtual void SetLabel(const QString& label) = 0; virtual bool operator==(const berry::Object* o) const = 0; }; } #endif /*MITKIDATASTORAGEREFERENCE_H_*/ diff --git a/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageService.h b/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageService.h index 3b31f7b5db..254dade2f2 100644 --- a/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageService.h +++ b/CoreUI/Bundles/org.mitk.core.services/src/mitkIDataStorageService.h @@ -1,57 +1,60 @@ /*========================================================================= Program: Medical Imaging & Interaction Toolkit Language: C++ Date: $Date$ Version: $Revision$ Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. See MITKCopyright.txt or http://www.mitk.org/copyright.html for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the above copyright notices for more information. =========================================================================*/ #ifndef MITKIDATASTORAGESERVICE_H_ #define MITKIDATASTORAGESERVICE_H_ #include #include #include "mitkIDataStorageReference.h" #include #include namespace mitk { +/** + * \ingroup org_mitk_core_services + */ struct MITK_CORE_SERVICES_PLUGIN IDataStorageService : public berry::Service { berryInterfaceMacro(IDataStorageService, berry); static const std::string ID; virtual IDataStorageReference::Pointer CreateDataStorage(const QString& label) = 0; virtual std::vector GetDataStorageReferences() const = 0; virtual IDataStorageReference::Pointer GetDefaultDataStorage() const = 0; virtual IDataStorageReference::Pointer GetDataStorage() const = 0; virtual IDataStorageReference::Pointer GetActiveDataStorage() const = 0; virtual void SetActiveDataStorage(IDataStorageReference::Pointer dataStorageRef) = 0; virtual void AddDataStorageReference(IDataStorageReference::Pointer dataStorageRef) = 0; virtual bool RemoveDataStorageReference(IDataStorageReference::Pointer dataStorageRef) = 0; }; } Q_DECLARE_INTERFACE(mitk::IDataStorageService, "org.mitk.service.IDataStorageService") #endif /*MITKIDATASTORAGESERVICE_H_*/