mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-05-02 08:49:20 -05:00
Add strict test for whitespace at end of line
More work on coding style
This commit is contained in:
@@ -43,7 +43,7 @@ struct Job {
|
||||
virtual std::shared_ptr<P> product() = 0;
|
||||
};
|
||||
|
||||
/*
|
||||
/*
|
||||
* Templated Concurrent Job Manager
|
||||
* This class is used execute specific jobs on one (1) parallell thread
|
||||
*/
|
||||
|
||||
@@ -41,7 +41,7 @@ class UniformLocation {
|
||||
public:
|
||||
|
||||
/**
|
||||
* Updates the uniform location of the uniform variable named <name>
|
||||
* Updates the uniform location of the uniform variable named <name>
|
||||
* in the provided shader program.
|
||||
*/
|
||||
void bind(ghoul::opengl::ProgramObject* program, const std::string& name);
|
||||
@@ -53,7 +53,7 @@ protected:
|
||||
|
||||
/**
|
||||
* Manages a GPU representation of the templated data type T.
|
||||
* This class provides a simple interface setting the value of
|
||||
* This class provides a simple interface setting the value of
|
||||
* the binded GLSL variable.
|
||||
*/
|
||||
template<typename T>
|
||||
@@ -71,13 +71,13 @@ public:
|
||||
|
||||
/**
|
||||
* Manages a Texture on the GPU.
|
||||
* This class provides a simple interface binding texture to the
|
||||
* This class provides a simple interface binding texture to the
|
||||
* named uniform.
|
||||
*/
|
||||
class GPUTexture : public UniformLocation{
|
||||
public:
|
||||
/**
|
||||
* Sets and assignes a texture unit within the provided shader
|
||||
* Sets and assignes a texture unit within the provided shader
|
||||
* program.
|
||||
* OBS! Users must ensure bind has been called before using this method.
|
||||
*/
|
||||
|
||||
@@ -49,10 +49,10 @@ public:
|
||||
* Enter value into the histogram. The add method takes the given
|
||||
* value, works out which bin this corresponds to, and increments
|
||||
* this bin by 'repeat'.
|
||||
*
|
||||
*
|
||||
* @param value The Value to insert into the histogram
|
||||
* @param repeat How many times you want to insert it
|
||||
*
|
||||
*
|
||||
* @return Returns true if succesful insertion, otherwise return false
|
||||
*/
|
||||
bool add(float value, float repeat = 1.0f);
|
||||
|
||||
@@ -45,7 +45,7 @@ namespace documentation { struct Documentation; }
|
||||
class OpenSpaceModule : public properties::PropertyOwner {
|
||||
public:
|
||||
/**
|
||||
* Constructs the OpenSpaceModule with a specific \p name. The uniqueness of the
|
||||
* Constructs the OpenSpaceModule with a specific \p name. The uniqueness of the
|
||||
* \p name will be checked at a later stage.
|
||||
* \param name The name of this OpenSpace module
|
||||
* \pre \p name must not be empty
|
||||
|
||||
@@ -630,7 +630,7 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* Returns the state vector (position and velocity) of a \p target body relative to an
|
||||
* Returns the state vector (position and velocity) of a \p target body relative to an
|
||||
* \p observer in a specific \p referenceFrame, optionally corrected for aberration
|
||||
* (\p aberrationCorrection).
|
||||
* \param target The target body name or the target body's NAIF ID
|
||||
@@ -660,7 +660,7 @@ public:
|
||||
const std::string& observer, const std::string& referenceFrame,
|
||||
AberrationCorrection aberrationCorrection, double ephemerisTime) const;
|
||||
|
||||
/**
|
||||
/**
|
||||
* Returns the state transformation matrix used to convert from the \p sourceFrame to
|
||||
* the \p destinationFrame at a specific \p ephemerisTime.
|
||||
* \param sourceFrame The name of the source reference frame
|
||||
@@ -824,7 +824,7 @@ public:
|
||||
bool addFrame(std::string body, std::string frame);
|
||||
|
||||
/**
|
||||
* This function returns the frame of a body if defined, otherwise it returns
|
||||
* This function returns the frame of a body if defined, otherwise it returns
|
||||
* IAU_ + body (most frames are known by the International Astronomical Union)
|
||||
* \param body - the name of the body
|
||||
* \return the frame of the body
|
||||
@@ -833,7 +833,7 @@ public:
|
||||
std::string frameFromBody(const std::string& body) const;
|
||||
|
||||
/**
|
||||
* Sets the SpiceManager's exception handling. If UseException::No is passed to this
|
||||
* Sets the SpiceManager's exception handling. If UseException::No is passed to this
|
||||
* function, all subsequent calls will not throw an error, but fail silently instead.
|
||||
* If set to UseException::Yes, a SpiceException is thrown whenever an error occurs.
|
||||
* \param useException The new exeception handling method that the SpiceManager should
|
||||
|
||||
@@ -53,13 +53,13 @@ protected:
|
||||
};
|
||||
|
||||
/**
|
||||
* A double buffered implementation of the Syncable interface.
|
||||
* Users are encouraged to used this class as a default way to synchronize different
|
||||
* A double buffered implementation of the Syncable interface.
|
||||
* Users are encouraged to used this class as a default way to synchronize different
|
||||
* C++ data types using the <code>SyncEngine</code>
|
||||
*
|
||||
* This class aims to handle the synchronization parts and yet act like a regular
|
||||
* instance of T. Implicit casts are supported, however, when accessing member functions or
|
||||
* or variables, user may have to do explicit casts.
|
||||
* This class aims to handle the synchronization parts and yet act like a regular
|
||||
* instance of T. Implicit casts are supported, however, when accessing member functions
|
||||
* or variables, user may have to do explicit casts.
|
||||
*
|
||||
* ((T&) t).method();
|
||||
*
|
||||
@@ -71,7 +71,7 @@ public:
|
||||
SyncData() {};
|
||||
SyncData(const T& val) : data(val) {};
|
||||
SyncData(const SyncData<T>& o) : data(o.data) {
|
||||
// Should not have to be copied!
|
||||
// Should not have to be copied!
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -40,7 +40,7 @@ namespace openspace {
|
||||
class ThreadPool;
|
||||
|
||||
class Worker {
|
||||
public:
|
||||
public:
|
||||
Worker(ThreadPool& pool);
|
||||
void operator()();
|
||||
private:
|
||||
|
||||
@@ -36,7 +36,7 @@ namespace openspace {
|
||||
/**
|
||||
* This singleton class represents the current simulation time in OpenSpace. It
|
||||
* internally stores the time and provides methods to set the time directly
|
||||
* (setTime(double), setTime(std::string)) using a <code>double</code> value using the
|
||||
* (setTime(double), setTime(std::string)) using a <code>double</code> value using the
|
||||
* number of seconds passed since the J2000 epoch or a <code>string</code> that denotes
|
||||
* a valid date string in accordance to the Spice library
|
||||
* (http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/str2et_c.html). The time can
|
||||
@@ -47,12 +47,12 @@ namespace openspace {
|
||||
* the number of seconds that pass for each real-time second. This value is set with
|
||||
* setDeltaTime(double), retrieved with deltaTime() and solely used in the
|
||||
* advanceTime(double), which takes a <code>tickTime</code> parameter. The value of the
|
||||
* parameter is dependent on the usage of the class and must be equal to the real-world
|
||||
* parameter is dependent on the usage of the class and must be equal to the real-world
|
||||
* time that has passed since the last call to the method. For example, if the
|
||||
* advanceTime(double) method is called each frame, the <code>tickTime</code> has to be
|
||||
* equal to the frame time.
|
||||
*
|
||||
* The synchronization of the simulation time requires
|
||||
* The synchronization of the simulation time requires
|
||||
*/
|
||||
class Time {
|
||||
public:
|
||||
@@ -144,7 +144,7 @@ public:
|
||||
double deltaTime() const;
|
||||
|
||||
/**
|
||||
* Sets the pause function, i.e. setting the deltaTime to 0 (<code>pause</code> =
|
||||
* Sets the pause function, i.e. setting the deltaTime to 0 (<code>pause</code> =
|
||||
* <code>true</code>) and restoring it when the function is called with a parameter of
|
||||
* <code>false</code>.
|
||||
* \param pause If <code>true</code>, the simulation time stops;
|
||||
|
||||
@@ -38,7 +38,7 @@ struct TimeRange {
|
||||
TimeRange();
|
||||
|
||||
/**
|
||||
* Initializes a TimeRange with both start and end time. Initializing empty timeranges
|
||||
* Initializes a TimeRange with both start and end time. Initializing empty timeranges
|
||||
* is OK.
|
||||
*/
|
||||
TimeRange(double startTime, double endTime);
|
||||
|
||||
Reference in New Issue
Block a user