mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-05-01 08:19:51 -05:00
Code cleanup branch (#618)
* Make height map fallback layer work again * Add documentation to joystick button bindings * Removed grouped property headers * Add new version number constant generated by CMake * Make Joystick deadzone work properly * Change the startup date on Earth to today * Fix key modifier handling * Add debugging indices for TreeNodeDebugging * Fix script schedule for OsirisRex * Do not open Mission schedule automatically * Upload default projection texture automatically * General code cleanup * Fix check_style_guide warnings * Remove .clang-format * MacOS compile fixes * Clang analyzer fixes
This commit is contained in:
@@ -25,10 +25,10 @@
|
||||
#ifndef __OPENSPACE_CORE___DOCUMENTATIONENGINE___H__
|
||||
#define __OPENSPACE_CORE___DOCUMENTATIONENGINE___H__
|
||||
|
||||
#include <openspace/documentation/documentation.h>
|
||||
#include <openspace/documentation/documentationgenerator.h>
|
||||
#include <ghoul/designpattern/singleton.h>
|
||||
|
||||
#include <openspace/documentation/documentation.h>
|
||||
#include <ghoul/misc/exception.h>
|
||||
|
||||
namespace openspace::documentation {
|
||||
@@ -50,10 +50,11 @@ public:
|
||||
/**
|
||||
* Constructor of a DuplicateDocumentationException storing the offending
|
||||
* Documentation for later use.
|
||||
* \param documentation The Documentation whose identifier was previously
|
||||
* registered
|
||||
*
|
||||
* \param doc The Documentation whose identifier was previously
|
||||
* registered
|
||||
*/
|
||||
DuplicateDocumentationException(Documentation documentation);
|
||||
DuplicateDocumentationException(Documentation doc);
|
||||
|
||||
/// The offending Documentation whose identifier was previously registered
|
||||
Documentation documentation;
|
||||
@@ -64,20 +65,24 @@ public:
|
||||
/**
|
||||
* Adds the \p documentation to the list of Documentation%s that are written to a
|
||||
* documentation file with the writeDocumentation method.
|
||||
*
|
||||
* \param documentation The Documentation object that is to be stored for later use
|
||||
* \throws DuplicateDocumentationException If the \p documentation has a non-empty
|
||||
* identifier and it was not unique
|
||||
*
|
||||
* \throw DuplicateDocumentationException If the \p documentation has a non-empty
|
||||
* identifier and it was not unique
|
||||
*/
|
||||
void addDocumentation(Documentation documentation);
|
||||
|
||||
/**
|
||||
* Returns a list of all registered Documentation%s
|
||||
* Returns a list of all registered Documentation%s.
|
||||
*
|
||||
* \return A list of all registered Documentation%s
|
||||
*/
|
||||
std::vector<Documentation> documentations() const;
|
||||
|
||||
/**
|
||||
* Returns a static reference to the main singleton DocumentationEngine
|
||||
* Returns a static reference to the main singleton DocumentationEngine.
|
||||
*
|
||||
* \return A static reference to the main singleton DocumentationEngine
|
||||
*/
|
||||
static DocumentationEngine& ref();
|
||||
|
||||
Reference in New Issue
Block a user