From 162141f2db0ca8a3dce19a0283159541554df9b5 Mon Sep 17 00:00:00 2001 From: Alexander Bock Date: Wed, 26 Jan 2022 23:41:48 +0100 Subject: [PATCH] Correctly expose missing documentation from a bunch of classes (closes #1856) --- modules/atmosphere/atmospheremodule.cpp | 6 ++++++ modules/atmosphere/atmospheremodule.h | 2 ++ modules/base/basemodule.cpp | 9 +++++++-- modules/base/dashboard/dashboarditemmission.cpp | 6 ++++++ modules/base/dashboard/dashboarditemmission.h | 2 ++ .../base/dashboard/dashboarditemparallelconnection.cpp | 6 ++++++ .../base/dashboard/dashboarditemparallelconnection.h | 2 ++ .../fieldlinessequence/fieldlinessequencemodule.cpp | 7 +++++++ modules/fieldlinessequence/fieldlinessequencemodule.h | 2 ++ modules/galaxy/galaxymodule.cpp | 4 +++- modules/galaxy/tasks/milkywayconversiontask.cpp | 2 +- modules/galaxy/tasks/milkywayconversiontask.h | 2 +- modules/galaxy/tasks/milkywaypointsconversiontask.cpp | 2 +- modules/galaxy/tasks/milkywaypointsconversiontask.h | 2 +- modules/globebrowsing/globebrowsingmodule.cpp | 8 ++++++++ modules/globebrowsing/src/layermanager.cpp | 1 + .../src/tileprovider/defaulttileprovider.cpp | 4 ++++ .../src/tileprovider/defaulttileprovider.h | 2 ++ .../src/tileprovider/imagesequencetileprovider.cpp | 4 ++++ .../src/tileprovider/imagesequencetileprovider.h | 2 ++ .../src/tileprovider/singleimagetileprovider.cpp | 4 ++++ .../src/tileprovider/singleimagetileprovider.h | 4 ++++ .../src/tileprovider/sizereferencetileprovider.cpp | 4 ++++ .../src/tileprovider/sizereferencetileprovider.h | 2 ++ .../src/tileprovider/temporaltileprovider.cpp | 4 ++++ .../src/tileprovider/temporaltileprovider.h | 2 ++ .../src/tileprovider/tileproviderbyindex.cpp | 4 ++++ .../src/tileprovider/tileproviderbyindex.h | 2 ++ .../src/tileprovider/tileproviderbylevel.cpp | 4 ++++ .../src/tileprovider/tileproviderbylevel.h | 2 ++ modules/space/spacemodule.cpp | 10 +++++----- modules/vislab/rendering/renderabledistancelabel.h | 2 +- modules/vislab/vislabmodule.cpp | 7 +++++++ modules/vislab/vislabmodule.h | 3 +++ modules/volume/tasks/generaterawvolumetask.cpp | 2 +- modules/volume/tasks/generaterawvolumetask.h | 2 +- modules/volume/volumemodule.cpp | 7 +++++++ modules/volume/volumemodule.h | 2 ++ 38 files changed, 127 insertions(+), 15 deletions(-) diff --git a/modules/atmosphere/atmospheremodule.cpp b/modules/atmosphere/atmospheremodule.cpp index 2d973d535b..c98166061f 100644 --- a/modules/atmosphere/atmospheremodule.cpp +++ b/modules/atmosphere/atmospheremodule.cpp @@ -25,6 +25,7 @@ #include #include +#include #include #include #include @@ -40,4 +41,9 @@ void AtmosphereModule::internalInitialize(const ghoul::Dictionary&) { fRenderable->registerClass("RenderableAtmosphere"); } +std::vector AtmosphereModule::documentations() const { + return { + RenderableAtmosphere::Documentation() + }; +} } // namespace openspace diff --git a/modules/atmosphere/atmospheremodule.h b/modules/atmosphere/atmospheremodule.h index 9ffb525245..82bc925158 100644 --- a/modules/atmosphere/atmospheremodule.h +++ b/modules/atmosphere/atmospheremodule.h @@ -35,6 +35,8 @@ public: AtmosphereModule(); + std::vector documentations() const override; + private: void internalInitialize(const ghoul::Dictionary&) override; }; diff --git a/modules/base/basemodule.cpp b/modules/base/basemodule.cpp index 895a00e93b..00a1b14ec8 100644 --- a/modules/base/basemodule.cpp +++ b/modules/base/basemodule.cpp @@ -197,11 +197,16 @@ std::vector BaseModule::documentations() const { DashboardItemDistance::Documentation(), DashboardItemFramerate::Documentation(), DashboardItemMission::Documentation(), + DashboardItemParallelConnection::Documentation(), + DashboardItemPropertyValue::Documentation(), DashboardItemSimulationIncrement::Documentation(), DashboardItemSpacing::Documentation(), + DashboardItemText::Documentation(), DashboardItemVelocity::Documentation(), RenderableBoxGrid::Documentation(), + RenderableCartesianAxes::Documentation(), + RenderableDisc::Documentation(), RenderableGrid::Documentation(), RenderableLabels::Documentation(), RenderableModel::Documentation(), @@ -210,8 +215,8 @@ std::vector BaseModule::documentations() const { RenderablePlaneImageLocal::Documentation(), RenderablePlaneImageOnline::Documentation(), RenderablePlaneTimeVaryingImage::Documentation(), + RenderablePrism::Documentation(), RenderableRadialGrid::Documentation(), - RenderableDisc::Documentation(), RenderableSphere::Documentation(), RenderableSphericalGrid::Documentation(), RenderableTimeVaryingSphere::Documentation(), @@ -241,8 +246,8 @@ std::vector BaseModule::documentations() const { TimeFrameInterval::Documentation(), TimeFrameUnion::Documentation(), - SceneGraphLightSource::Documentation(), CameraLightSource::Documentation(), + SceneGraphLightSource::Documentation() }; } diff --git a/modules/base/dashboard/dashboarditemmission.cpp b/modules/base/dashboard/dashboarditemmission.cpp index ae584d2732..d86dadb5e2 100644 --- a/modules/base/dashboard/dashboarditemmission.cpp +++ b/modules/base/dashboard/dashboarditemmission.cpp @@ -55,6 +55,12 @@ namespace { namespace openspace { +documentation::Documentation DashboardItemMission::Documentation() { + documentation::Documentation doc = DashboardTextItem::Documentation(); + doc.id = "base_dashboarditem_mission"; + return doc; +} + DashboardItemMission::DashboardItemMission(const ghoul::Dictionary& dictionary) : DashboardTextItem(dictionary, 15.f) {} diff --git a/modules/base/dashboard/dashboarditemmission.h b/modules/base/dashboard/dashboarditemmission.h index 6de41c30e5..d197f79a21 100644 --- a/modules/base/dashboard/dashboarditemmission.h +++ b/modules/base/dashboard/dashboarditemmission.h @@ -39,6 +39,8 @@ public: void render(glm::vec2& penPosition) override; glm::vec2 size() const override; + + static documentation::Documentation Documentation(); }; } // namespace openspace diff --git a/modules/base/dashboard/dashboarditemparallelconnection.cpp b/modules/base/dashboard/dashboarditemparallelconnection.cpp index 13f3375077..02e68e00dc 100644 --- a/modules/base/dashboard/dashboarditemparallelconnection.cpp +++ b/modules/base/dashboard/dashboarditemparallelconnection.cpp @@ -38,6 +38,12 @@ namespace openspace { +documentation::Documentation DashboardItemParallelConnection::Documentation() { + documentation::Documentation doc = DashboardTextItem::Documentation(); + doc.id = "base_dashboarditem_parallelconnection"; + return doc; +} + DashboardItemParallelConnection::DashboardItemParallelConnection( const ghoul::Dictionary& dictionary) : DashboardTextItem(dictionary) diff --git a/modules/base/dashboard/dashboarditemparallelconnection.h b/modules/base/dashboard/dashboarditemparallelconnection.h index f643eff442..4b4f5c12a7 100644 --- a/modules/base/dashboard/dashboarditemparallelconnection.h +++ b/modules/base/dashboard/dashboarditemparallelconnection.h @@ -39,6 +39,8 @@ public: void render(glm::vec2& penPosition) override; glm::vec2 size() const override; + + static documentation::Documentation Documentation(); }; } // namespace openspace diff --git a/modules/fieldlinessequence/fieldlinessequencemodule.cpp b/modules/fieldlinessequence/fieldlinessequencemodule.cpp index 8184781050..b832c33571 100644 --- a/modules/fieldlinessequence/fieldlinessequencemodule.cpp +++ b/modules/fieldlinessequence/fieldlinessequencemodule.cpp @@ -25,6 +25,7 @@ #include #include +#include #include #include #include @@ -65,4 +66,10 @@ void FieldlinesSequenceModule::internalInitialize(const ghoul::Dictionary&) { factory->registerClass("RenderableFieldlinesSequence"); } +std::vector FieldlinesSequenceModule::documentations() const { + return { + RenderableFieldlinesSequence::Documentation() + }; +} + } // namespace openspace diff --git a/modules/fieldlinessequence/fieldlinessequencemodule.h b/modules/fieldlinessequence/fieldlinessequencemodule.h index 45c444ffaf..28e83c560a 100644 --- a/modules/fieldlinessequence/fieldlinessequencemodule.h +++ b/modules/fieldlinessequence/fieldlinessequencemodule.h @@ -35,6 +35,8 @@ public: FieldlinesSequenceModule(); + std::vector documentations() const override; + static std::string DefaultTransferFunctionFile; private: diff --git a/modules/galaxy/galaxymodule.cpp b/modules/galaxy/galaxymodule.cpp index 0000784d55..f2917b8be5 100644 --- a/modules/galaxy/galaxymodule.cpp +++ b/modules/galaxy/galaxymodule.cpp @@ -50,7 +50,9 @@ void GalaxyModule::internalInitialize(const ghoul::Dictionary&) { std::vector GalaxyModule::documentations() const { return { - RenderableGalaxy::Documentation() + RenderableGalaxy::Documentation(), + MilkywayConversionTask::Documentation(), + MilkywayPointsConversionTask::Documentation() }; } diff --git a/modules/galaxy/tasks/milkywayconversiontask.cpp b/modules/galaxy/tasks/milkywayconversiontask.cpp index 24073c3547..df03bffd2d 100644 --- a/modules/galaxy/tasks/milkywayconversiontask.cpp +++ b/modules/galaxy/tasks/milkywayconversiontask.cpp @@ -107,7 +107,7 @@ void MilkywayConversionTask::perform(const Task::ProgressCallback& onProgress) { rawWriter.write(sampleFunction, onProgress); } -documentation::Documentation MilkywayConversionTask::documentation() { +documentation::Documentation MilkywayConversionTask::Documentation() { return documentation::Documentation(); } diff --git a/modules/galaxy/tasks/milkywayconversiontask.h b/modules/galaxy/tasks/milkywayconversiontask.h index d40c7860f6..a546b3e212 100644 --- a/modules/galaxy/tasks/milkywayconversiontask.h +++ b/modules/galaxy/tasks/milkywayconversiontask.h @@ -45,7 +45,7 @@ public: std::string description() override; void perform(const Task::ProgressCallback& onProgress) override; - static documentation::Documentation documentation(); + static documentation::Documentation Documentation(); private: std::string _inFilenamePrefix; diff --git a/modules/galaxy/tasks/milkywaypointsconversiontask.cpp b/modules/galaxy/tasks/milkywaypointsconversiontask.cpp index a8d1841ce7..0aa0b4b4a2 100644 --- a/modules/galaxy/tasks/milkywaypointsconversiontask.cpp +++ b/modules/galaxy/tasks/milkywaypointsconversiontask.cpp @@ -90,7 +90,7 @@ void MilkywayPointsConversionTask::perform(const Task::ProgressCallback& progres out.close(); } -documentation::Documentation MilkywayPointsConversionTask::documentation() { +documentation::Documentation MilkywayPointsConversionTask::Documentation() { return documentation::Documentation(); } diff --git a/modules/galaxy/tasks/milkywaypointsconversiontask.h b/modules/galaxy/tasks/milkywaypointsconversiontask.h index 332dcb1ec2..2eaf5ec980 100644 --- a/modules/galaxy/tasks/milkywaypointsconversiontask.h +++ b/modules/galaxy/tasks/milkywaypointsconversiontask.h @@ -47,7 +47,7 @@ public: std::string description() override; void perform(const Task::ProgressCallback& progressCallback) override; - static documentation::Documentation documentation(); + static documentation::Documentation Documentation(); private: std::string _inFilename; diff --git a/modules/globebrowsing/globebrowsingmodule.cpp b/modules/globebrowsing/globebrowsingmodule.cpp index baeef89d6d..7b8aa4f4bf 100644 --- a/modules/globebrowsing/globebrowsingmodule.cpp +++ b/modules/globebrowsing/globebrowsingmodule.cpp @@ -483,7 +483,15 @@ std::vector GlobeBrowsingModule::documentations() globebrowsing::LayerAdjustment::Documentation(), globebrowsing::LayerManager::Documentation(), globebrowsing::GlobeTranslation::Documentation(), + globebrowsing::GlobeRotation::Documentation(), globebrowsing::RenderableGlobe::Documentation(), + globebrowsing::DefaultTileProvider::Documentation(), + globebrowsing::ImageSequenceTileProvider::Documentation(), + globebrowsing::SingleImageProvider::Documentation(), + globebrowsing::SizeReferenceTileProvider::Documentation(), + globebrowsing::TemporalTileProvider::Documentation(), + globebrowsing::TileProviderByIndex::Documentation(), + globebrowsing::TileProviderByLevel::Documentation(), GlobeLabelsComponent::Documentation(), RingsComponent::Documentation(), ShadowComponent::Documentation() diff --git a/modules/globebrowsing/src/layermanager.cpp b/modules/globebrowsing/src/layermanager.cpp index 5c060fe8fe..612c42a64f 100644 --- a/modules/globebrowsing/src/layermanager.cpp +++ b/modules/globebrowsing/src/layermanager.cpp @@ -106,6 +106,7 @@ Layer* LayerManager::addLayer(layergroupid::GroupID groupId, for (const documentation::TestResult::Warning& w : e.result.warnings) { LWARNINGC(w.offender, ghoul::to_string(w.reason)); } + return nullptr; } catch (const ghoul::RuntimeError& e) { LERRORC(e.component, e.message); diff --git a/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp b/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp index 7047094a45..6a11f3acb4 100644 --- a/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/defaulttileprovider.cpp @@ -76,6 +76,10 @@ namespace { namespace openspace::globebrowsing { +documentation::Documentation DefaultTileProvider::Documentation() { + return codegen::doc("globebrowsing_defaulttileprovider"); +} + DefaultTileProvider::DefaultTileProvider(const ghoul::Dictionary& dictionary) : _filePath(FilePathInfo, "") , _tilePixelSize(TilePixelSizeInfo, 32, 32, 2048) diff --git a/modules/globebrowsing/src/tileprovider/defaulttileprovider.h b/modules/globebrowsing/src/tileprovider/defaulttileprovider.h index 51250ca02f..0cb6195ea8 100644 --- a/modules/globebrowsing/src/tileprovider/defaulttileprovider.h +++ b/modules/globebrowsing/src/tileprovider/defaulttileprovider.h @@ -44,6 +44,8 @@ public: int maxLevel() override final; float noDataValueAsFloat() override final; + static documentation::Documentation Documentation(); + private: void initAsyncTileDataReader(TileTextureInitData initData); diff --git a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp index 2bf0485566..f922c99681 100644 --- a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.cpp @@ -61,6 +61,10 @@ namespace { namespace openspace::globebrowsing { +documentation::Documentation ImageSequenceTileProvider::Documentation() { + return codegen::doc("globebrowsing_imagesequencetileprovider"); +} + ImageSequenceTileProvider::ImageSequenceTileProvider(const ghoul::Dictionary& dictionary) : _index(IndexInfo, 0) , _currentImage(CurrentImageInfo) diff --git a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.h b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.h index 0ee4730db9..afacdfe05b 100644 --- a/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.h +++ b/modules/globebrowsing/src/tileprovider/imagesequencetileprovider.h @@ -43,6 +43,8 @@ public: int maxLevel() override final; float noDataValueAsFloat() override final; + static documentation::Documentation Documentation(); + private: std::unique_ptr _currentTileProvider = nullptr; diff --git a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp index a4a113b2b9..a6e6911ef2 100644 --- a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.cpp @@ -44,6 +44,10 @@ namespace { namespace openspace::globebrowsing { +documentation::Documentation SingleImageProvider::Documentation() { + return codegen::doc("globebrowsing_singleimageprovider"); +} + SingleImageProvider::SingleImageProvider(const ghoul::Dictionary& dictionary) : _filePath(FilePathInfo) { diff --git a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.h b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.h index c3fee2725b..a911c719f3 100644 --- a/modules/globebrowsing/src/tileprovider/singleimagetileprovider.h +++ b/modules/globebrowsing/src/tileprovider/singleimagetileprovider.h @@ -27,6 +27,8 @@ #include +namespace openspace { struct Documentation; } + namespace openspace::globebrowsing { class SingleImageProvider : public TileProvider { @@ -41,6 +43,8 @@ public: int maxLevel() override final; float noDataValueAsFloat() override final; + static documentation::Documentation Documentation(); + private: properties::StringProperty _filePath; diff --git a/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.cpp b/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.cpp index 9343d5a99e..a179af979f 100644 --- a/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.cpp @@ -40,6 +40,10 @@ namespace { namespace openspace::globebrowsing { +documentation::Documentation SizeReferenceTileProvider::Documentation() { + return codegen::doc("globebrowsing_sizereferencetileprovider"); +} + SizeReferenceTileProvider::SizeReferenceTileProvider(const ghoul::Dictionary& dictionary) : TextTileProvider(tileTextureInitData(layergroupid::GroupID::ColorLayers, false)) { diff --git a/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.h b/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.h index 499f8c2a53..adb25c42c7 100644 --- a/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.h +++ b/modules/globebrowsing/src/tileprovider/sizereferencetileprovider.h @@ -40,6 +40,8 @@ public: int maxLevel() override final; float noDataValueAsFloat() override final; + static documentation::Documentation Documentation(); + private: Ellipsoid _ellipsoid; }; diff --git a/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp b/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp index bc71de7b14..6284ded487 100644 --- a/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp +++ b/modules/globebrowsing/src/tileprovider/temporaltileprovider.cpp @@ -165,6 +165,10 @@ namespace { namespace openspace::globebrowsing { +documentation::Documentation TemporalTileProvider::Documentation() { + return codegen::doc("globebrowsing_temporaltileprovider"); +} + TemporalTileProvider::TemporalTileProvider(const ghoul::Dictionary& dictionary) : _initDict(dictionary) , _useFixedTime(UseFixedTimeInfo, false) diff --git a/modules/globebrowsing/src/tileprovider/temporaltileprovider.h b/modules/globebrowsing/src/tileprovider/temporaltileprovider.h index 95dfc1f128..469251ac4c 100644 --- a/modules/globebrowsing/src/tileprovider/temporaltileprovider.h +++ b/modules/globebrowsing/src/tileprovider/temporaltileprovider.h @@ -54,6 +54,8 @@ public: int maxLevel() override final; float noDataValueAsFloat() override final; + static documentation::Documentation Documentation(); + private: enum class Mode { Prototype, diff --git a/modules/globebrowsing/src/tileprovider/tileproviderbyindex.cpp b/modules/globebrowsing/src/tileprovider/tileproviderbyindex.cpp index af85ae70d8..c9871e92f1 100644 --- a/modules/globebrowsing/src/tileprovider/tileproviderbyindex.cpp +++ b/modules/globebrowsing/src/tileprovider/tileproviderbyindex.cpp @@ -51,6 +51,10 @@ namespace { namespace openspace::globebrowsing { +documentation::Documentation TileProviderByIndex::Documentation() { + return codegen::doc("globebrowsing_tileproviderbyindex"); +} + TileProviderByIndex::TileProviderByIndex(const ghoul::Dictionary& dictionary) { ZoneScoped diff --git a/modules/globebrowsing/src/tileprovider/tileproviderbyindex.h b/modules/globebrowsing/src/tileprovider/tileproviderbyindex.h index 1d523748e2..9af02b6378 100644 --- a/modules/globebrowsing/src/tileprovider/tileproviderbyindex.h +++ b/modules/globebrowsing/src/tileprovider/tileproviderbyindex.h @@ -41,6 +41,8 @@ public: int maxLevel() override final; float noDataValueAsFloat() override final; + static documentation::Documentation Documentation(); + private: std::unordered_map> _providers; std::unique_ptr _defaultTileProvider; diff --git a/modules/globebrowsing/src/tileprovider/tileproviderbylevel.cpp b/modules/globebrowsing/src/tileprovider/tileproviderbylevel.cpp index c27576012d..e082cdac98 100644 --- a/modules/globebrowsing/src/tileprovider/tileproviderbylevel.cpp +++ b/modules/globebrowsing/src/tileprovider/tileproviderbylevel.cpp @@ -41,6 +41,10 @@ namespace { namespace openspace::globebrowsing { +documentation::Documentation TileProviderByLevel::Documentation() { + return codegen::doc("globebrowsing_tileproviderbylevel"); +} + TileProviderByLevel::TileProviderByLevel(const ghoul::Dictionary& dictionary) { ZoneScoped diff --git a/modules/globebrowsing/src/tileprovider/tileproviderbylevel.h b/modules/globebrowsing/src/tileprovider/tileproviderbylevel.h index 1ec3c4995e..1020c5d29d 100644 --- a/modules/globebrowsing/src/tileprovider/tileproviderbylevel.h +++ b/modules/globebrowsing/src/tileprovider/tileproviderbylevel.h @@ -41,6 +41,8 @@ public: int maxLevel() override final; float noDataValueAsFloat() override final; + static documentation::Documentation Documentation(); + private: std::vector _providerIndices; std::vector> _levelTileProviders; diff --git a/modules/space/spacemodule.cpp b/modules/space/spacemodule.cpp index cdaaf62509..062a9623eb 100644 --- a/modules/space/spacemodule.cpp +++ b/modules/space/spacemodule.cpp @@ -124,6 +124,9 @@ void SpaceModule::internalDeinitializeGL() { std::vector SpaceModule::documentations() const { return { + HorizonsTranslation::Documentation(), + KeplerTranslation::Documentation(), + planetgeometry::PlanetGeometry::Documentation(), RenderableConstellationBounds::Documentation(), RenderableFluxNodes::Documentation(), RenderableHabitableZone::Documentation(), @@ -132,13 +135,10 @@ std::vector SpaceModule::documentations() const { RenderableSmallBody::Documentation(), RenderableStars::Documentation(), RenderableTravelSpeed::Documentation(), + planetgeometry::SimpleSphereGeometry::Documentation(), SpiceRotation::Documentation(), SpiceTranslation::Documentation(), - KeplerTranslation::Documentation(), - TLETranslation::Documentation(), - HorizonsTranslation::Documentation(), - planetgeometry::PlanetGeometry::Documentation(), - planetgeometry::SimpleSphereGeometry::Documentation() + TLETranslation::Documentation() }; } diff --git a/modules/vislab/rendering/renderabledistancelabel.h b/modules/vislab/rendering/renderabledistancelabel.h index 330c00510b..3a0b765aad 100644 --- a/modules/vislab/rendering/renderabledistancelabel.h +++ b/modules/vislab/rendering/renderabledistancelabel.h @@ -37,8 +37,8 @@ public: void update(const UpdateData& data) override; static documentation::Documentation Documentation(); -private: +private: properties::StringProperty _nodelineId; properties::IntProperty _distanceUnit; properties::StringProperty _customUnitDescriptor; diff --git a/modules/vislab/vislabmodule.cpp b/modules/vislab/vislabmodule.cpp index 2356928bbf..399923f651 100644 --- a/modules/vislab/vislabmodule.cpp +++ b/modules/vislab/vislabmodule.cpp @@ -25,6 +25,7 @@ #include #include +#include #include #include #include @@ -40,4 +41,10 @@ void VisLabModule::internalInitialize(const ghoul::Dictionary&) { renderableFactory->registerClass("RenderableDistanceLabel"); } +std::vectorVisLabModule::documentations() const { + return { + RenderableDistanceLabel::Documentation() + }; +} + } // namespace openspace diff --git a/modules/vislab/vislabmodule.h b/modules/vislab/vislabmodule.h index 1ebf9cfaf3..5e2b7a6079 100644 --- a/modules/vislab/vislabmodule.h +++ b/modules/vislab/vislabmodule.h @@ -35,6 +35,9 @@ public: VisLabModule(); + std::vector documentations() const override; + + private: void internalInitialize(const ghoul::Dictionary&) override; }; diff --git a/modules/volume/tasks/generaterawvolumetask.cpp b/modules/volume/tasks/generaterawvolumetask.cpp index 66e5833680..f0e3a7d74b 100644 --- a/modules/volume/tasks/generaterawvolumetask.cpp +++ b/modules/volume/tasks/generaterawvolumetask.cpp @@ -71,7 +71,7 @@ namespace { namespace openspace::volume { -documentation::Documentation GenerateRawVolumeTask::documentation() { +documentation::Documentation GenerateRawVolumeTask::Documentation() { return codegen::doc("generate_raw_volume_task"); } diff --git a/modules/volume/tasks/generaterawvolumetask.h b/modules/volume/tasks/generaterawvolumetask.h index 384b767339..7d302727a6 100644 --- a/modules/volume/tasks/generaterawvolumetask.h +++ b/modules/volume/tasks/generaterawvolumetask.h @@ -38,7 +38,7 @@ public: GenerateRawVolumeTask(const ghoul::Dictionary& dictionary); std::string description() override; void perform(const Task::ProgressCallback& progressCallback) override; - static documentation::Documentation documentation(); + static documentation::Documentation Documentation(); private: std::filesystem::path _rawVolumeOutputPath; diff --git a/modules/volume/volumemodule.cpp b/modules/volume/volumemodule.cpp index 2f3b34dd1d..7900e671c8 100644 --- a/modules/volume/volumemodule.cpp +++ b/modules/volume/volumemodule.cpp @@ -26,6 +26,7 @@ #include #include +#include #include #include #include @@ -46,7 +47,13 @@ void VolumeModule::internalInitialize(const ghoul::Dictionary&) { auto tFactory = FactoryManager::ref().factory(); ghoul_assert(tFactory, "No task factory existed"); tFactory->registerClass("GenerateRawVolumeTask"); +} +std::vector VolumeModule::documentations() const { + return { + RenderableTimeVaryingVolume::Documentation(), + GenerateRawVolumeTask::Documentation() + }; } } // namespace openspace diff --git a/modules/volume/volumemodule.h b/modules/volume/volumemodule.h index 8808f7ae68..cf850323ca 100644 --- a/modules/volume/volumemodule.h +++ b/modules/volume/volumemodule.h @@ -36,6 +36,8 @@ public: VolumeModule(); void internalInitialize(const ghoul::Dictionary&) override; + + std::vector documentations() const override; }; } // namespace openspace