Correctly expose missing documentation from a bunch of classes (closes #1856)

This commit is contained in:
Alexander Bock
2022-01-26 23:41:48 +01:00
parent 2cf268abf0
commit 162141f2db
38 changed files with 127 additions and 15 deletions
@@ -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);
@@ -76,6 +76,10 @@ namespace {
namespace openspace::globebrowsing {
documentation::Documentation DefaultTileProvider::Documentation() {
return codegen::doc<Parameters>("globebrowsing_defaulttileprovider");
}
DefaultTileProvider::DefaultTileProvider(const ghoul::Dictionary& dictionary)
: _filePath(FilePathInfo, "")
, _tilePixelSize(TilePixelSizeInfo, 32, 32, 2048)
@@ -44,6 +44,8 @@ public:
int maxLevel() override final;
float noDataValueAsFloat() override final;
static documentation::Documentation Documentation();
private:
void initAsyncTileDataReader(TileTextureInitData initData);
@@ -61,6 +61,10 @@ namespace {
namespace openspace::globebrowsing {
documentation::Documentation ImageSequenceTileProvider::Documentation() {
return codegen::doc<Parameters>("globebrowsing_imagesequencetileprovider");
}
ImageSequenceTileProvider::ImageSequenceTileProvider(const ghoul::Dictionary& dictionary)
: _index(IndexInfo, 0)
, _currentImage(CurrentImageInfo)
@@ -43,6 +43,8 @@ public:
int maxLevel() override final;
float noDataValueAsFloat() override final;
static documentation::Documentation Documentation();
private:
std::unique_ptr<DefaultTileProvider> _currentTileProvider = nullptr;
@@ -44,6 +44,10 @@ namespace {
namespace openspace::globebrowsing {
documentation::Documentation SingleImageProvider::Documentation() {
return codegen::doc<Parameters>("globebrowsing_singleimageprovider");
}
SingleImageProvider::SingleImageProvider(const ghoul::Dictionary& dictionary)
: _filePath(FilePathInfo)
{
@@ -27,6 +27,8 @@
#include <modules/globebrowsing/src/tileprovider/tileprovider.h>
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;
@@ -40,6 +40,10 @@ namespace {
namespace openspace::globebrowsing {
documentation::Documentation SizeReferenceTileProvider::Documentation() {
return codegen::doc<Parameters>("globebrowsing_sizereferencetileprovider");
}
SizeReferenceTileProvider::SizeReferenceTileProvider(const ghoul::Dictionary& dictionary)
: TextTileProvider(tileTextureInitData(layergroupid::GroupID::ColorLayers, false))
{
@@ -40,6 +40,8 @@ public:
int maxLevel() override final;
float noDataValueAsFloat() override final;
static documentation::Documentation Documentation();
private:
Ellipsoid _ellipsoid;
};
@@ -165,6 +165,10 @@ namespace {
namespace openspace::globebrowsing {
documentation::Documentation TemporalTileProvider::Documentation() {
return codegen::doc<Parameters>("globebrowsing_temporaltileprovider");
}
TemporalTileProvider::TemporalTileProvider(const ghoul::Dictionary& dictionary)
: _initDict(dictionary)
, _useFixedTime(UseFixedTimeInfo, false)
@@ -54,6 +54,8 @@ public:
int maxLevel() override final;
float noDataValueAsFloat() override final;
static documentation::Documentation Documentation();
private:
enum class Mode {
Prototype,
@@ -51,6 +51,10 @@ namespace {
namespace openspace::globebrowsing {
documentation::Documentation TileProviderByIndex::Documentation() {
return codegen::doc<Parameters>("globebrowsing_tileproviderbyindex");
}
TileProviderByIndex::TileProviderByIndex(const ghoul::Dictionary& dictionary) {
ZoneScoped
@@ -41,6 +41,8 @@ public:
int maxLevel() override final;
float noDataValueAsFloat() override final;
static documentation::Documentation Documentation();
private:
std::unordered_map<TileIndex::TileHashKey, std::unique_ptr<TileProvider>> _providers;
std::unique_ptr<TileProvider> _defaultTileProvider;
@@ -41,6 +41,10 @@ namespace {
namespace openspace::globebrowsing {
documentation::Documentation TileProviderByLevel::Documentation() {
return codegen::doc<Parameters>("globebrowsing_tileproviderbylevel");
}
TileProviderByLevel::TileProviderByLevel(const ghoul::Dictionary& dictionary) {
ZoneScoped
@@ -41,6 +41,8 @@ public:
int maxLevel() override final;
float noDataValueAsFloat() override final;
static documentation::Documentation Documentation();
private:
std::vector<int> _providerIndices;
std::vector<std::unique_ptr<TileProvider>> _levelTileProviders;