mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-05-01 00:09:58 -05:00
Harmonize various documentation identifiers
This commit is contained in:
@@ -67,7 +67,7 @@ namespace {
|
||||
// renderable and add it as a child to the other scene graph node, i.e. specify the
|
||||
// other node as the `Parent` of the node with this renderable. Also, the axes have to
|
||||
// be scaled to match the parent object for the axes to be visible in the scene, for
|
||||
// example using a [StaticScale](#base_scale_static).
|
||||
// example using a [StaticScale](#base_transform_scale_static).
|
||||
struct [[codegen::Dictionary(RenderableCartesianAxes)]] Parameters {
|
||||
// [[codegen::verbatim(XColorInfo.description)]]
|
||||
std::optional<glm::vec3> xColor [[codegen::color()]];
|
||||
|
||||
@@ -60,7 +60,7 @@ namespace {
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation LuaScale::Documentation() {
|
||||
return codegen::doc<Parameters>("base_scale_lua");
|
||||
return codegen::doc<Parameters>("base_transform_scale_lua");
|
||||
}
|
||||
|
||||
LuaScale::LuaScale(const ghoul::Dictionary& dictionary)
|
||||
|
||||
@@ -36,7 +36,7 @@ namespace {
|
||||
struct [[codegen::Dictionary(MultiScale)]] Parameters {
|
||||
// The list of scales that are applied one after the other
|
||||
std::vector<ghoul::Dictionary> scales
|
||||
[[codegen::reference("core_transform_scaling")]];
|
||||
[[codegen::reference("core_transform_scale")]];
|
||||
};
|
||||
#include "multiscale_codegen.cpp"
|
||||
} // namespace
|
||||
@@ -44,7 +44,7 @@ namespace {
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation MultiScale::Documentation() {
|
||||
return codegen::doc<Parameters>("base_scale_multi");
|
||||
return codegen::doc<Parameters>("base_transform_scale_multi");
|
||||
}
|
||||
|
||||
MultiScale::MultiScale(const ghoul::Dictionary& dictionary) {
|
||||
|
||||
@@ -56,7 +56,7 @@ namespace {
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation NonUniformStaticScale::Documentation() {
|
||||
return codegen::doc<Parameters>("base_scale_nonuniformstatic");
|
||||
return codegen::doc<Parameters>("base_transform_scale_nonuniformstatic");
|
||||
}
|
||||
|
||||
NonUniformStaticScale::NonUniformStaticScale(const ghoul::Dictionary& dictionary)
|
||||
|
||||
@@ -51,7 +51,7 @@ namespace {
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation StaticScale::Documentation() {
|
||||
return codegen::doc<Parameters>("base_scale_static");
|
||||
return codegen::doc<Parameters>("base_transform_scale_static");
|
||||
}
|
||||
|
||||
StaticScale::StaticScale(const ghoul::Dictionary& dictionary)
|
||||
|
||||
@@ -83,7 +83,7 @@ namespace {
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation TimeDependentScale::Documentation() {
|
||||
return codegen::doc<Parameters>("base_scale_timedependent");
|
||||
return codegen::doc<Parameters>("base_transform_scale_timedependent");
|
||||
}
|
||||
|
||||
TimeDependentScale::TimeDependentScale(const ghoul::Dictionary& dictionary)
|
||||
|
||||
@@ -110,7 +110,7 @@ std::string to_string(const openspace::documentation::TestResult::Offense::Reaso
|
||||
case openspace::documentation::TestResult::Offense::Reason::MissingKey:
|
||||
return "Missing key";
|
||||
case openspace::documentation::TestResult::Offense::Reason::UnknownIdentifier:
|
||||
return "Unknown identifier";
|
||||
return "Unknown documentation identifier";
|
||||
case openspace::documentation::TestResult::Offense::Reason::Verification:
|
||||
return "Verification failed";
|
||||
case openspace::documentation::TestResult::Offense::Reason::WrongType:
|
||||
|
||||
+1
-1
@@ -47,7 +47,7 @@ namespace {
|
||||
namespace openspace {
|
||||
|
||||
documentation::Documentation Scale::Documentation() {
|
||||
return codegen::doc<Parameters>("core_transform_scaling");
|
||||
return codegen::doc<Parameters>("core_transform_scale");
|
||||
}
|
||||
|
||||
ghoul::mm_unique_ptr<Scale> Scale::createFromDictionary(
|
||||
|
||||
@@ -264,7 +264,7 @@ namespace {
|
||||
// all its children. Depending on the 'Type' of the scaling, this can either
|
||||
// be a static scaling or a time-varying one
|
||||
std::optional<ghoul::Dictionary> scale
|
||||
[[codegen::reference("core_transform_scaling")]];
|
||||
[[codegen::reference("core_transform_scale")]];
|
||||
};
|
||||
|
||||
// This describes a set of transformations that are applied to this scene graph
|
||||
|
||||
Reference in New Issue
Block a user