mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-01-05 11:09:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Remove generateJson function from the DocumentationGenerator and move sortJson function to json_helper

Browse Source
This commit is contained in:
Ylva Selling
2023-04-25 16:32:04 -04:00
parent b8b2867a20
commit 948fdd024b
15 changed files with 51 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/openspace/documentation/documentationengine.h
View File

@@ -89,7 +89,7 @@ public:
*/
static DocumentationEngine& ref();
std::string generateJson() const override;
std::string generateJson() const;
nlohmann::json generateJsonJson() const;

1
include/openspace/documentation/documentationgenerator.h
View File

@@ -79,7 +79,6 @@ public:
*/
virtual std::string generateJson() const = 0;
void sortJson(nlohmann::json& json) const;
private:
const std::string _name;
const std::string _jsonName;

2
include/openspace/interaction/keybindingmanager.h
View File

@@ -55,7 +55,7 @@ public:
void keyboardCallback(Key key, KeyModifier modifier, KeyAction action);
std::string generateJson() const override;
std::string generateJson() const;
nlohmann::json generateJsonJson() const;
const std::multimap<KeyWithModifier, std::string>& keyBindings() const;

2
include/openspace/properties/propertyowner.h
View File

@@ -297,7 +297,7 @@ public:
void removeTag(const std::string& tag);
// Generate JSON for documentation
std::string generateJson() const override;
std::string generateJson() const;
nlohmann::json generateJsonJson() const;

2
include/openspace/scene/scenelicensewriter.h
View File

@@ -35,7 +35,7 @@ namespace openspace {
class SceneLicenseWriter : public DocumentationGenerator {
public:
SceneLicenseWriter();
std::string generateJson() const override;
std::string generateJson() const;
nlohmann::json generateJsonJson() const;
};

2
include/openspace/scripting/scriptengine.h
View File

@@ -95,7 +95,7 @@ public:
std::vector<std::string> allLuaFunctions() const;
std::string generateJson() const override;
std::string generateJson() const;
nlohmann::json generateJsonJson() const;
private:

2
include/openspace/util/factorymanager.h
View File

@@ -109,7 +109,7 @@ public:
template <class T>
ghoul::TemplateFactory<T>* factory() const;
std::string generateJson() const override;
std::string generateJson() const;
nlohmann::json generateJsonJson() const;
private:

11
include/openspace/util/json_helper.h
View File

@@ -26,6 +26,7 @@
#define __OPENSPACE_CORE___JSON_HELPER___H__
#include <string>
#include <openspace/json.h>
namespace openspace {
@@ -65,6 +66,16 @@ std::string formatJsonNumber(double d);
template <typename T>
std::string formatJson(T value);
/**
* Sort a json object that is an array of objects with the structure
* [ key = {}, key = {} ...]. Sorts it by the provided key
*
* \param json The json to sort
* \param key The key the json should be sorted by
* \return The sorted JSON
*/
void sortJson(nlohmann::json& json, const std::string& key);
} // namespace openspace
#include "json_helper.inl"