From eeeaa70e8bed89d8c8d70c9f22a2c87d8c6669fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Lemaire?= Date: Wed, 6 Jan 2016 19:55:49 +0100 Subject: [PATCH] Fixed emphasis in docstrings --- src/basics/Vector3.h | 4 ++-- src/definition/DefinitionNode.h | 6 +++--- src/definition/TimeManager.h | 2 +- src/definition/VegetationPresenceDefinition.h | 2 +- src/interface/modeler/BaseModelerTool.h | 4 ++-- src/interface/modeler/ModelerCameras.h | 2 +- src/render/opengl/OpenGLRenderer.h | 2 +- src/render/opengl/OpenGLShaderProgram.h | 2 +- src/render/opengl/OpenGLTerrainChunk.cpp | 2 +- src/render/opengl/OpenGLTerrainChunk.h | 8 ++++---- src/render/opengl/OpenGLVariable.h | 2 +- src/render/opengl/OpenGLVegetation.h | 2 +- src/render/opengl/OpenGLVegetationLayer.h | 2 +- src/render/software/FluidMediumManager.h | 2 +- src/render/software/GodRaysSampler.h | 4 ++-- src/render/software/LightSource.h | 2 +- src/render/software/NightSky.h | 2 +- src/render/software/TerrainRasterizer.h | 2 +- src/render/software/VegetationRenderer.h | 4 ++-- src/system/PackStream.h | 2 +- src/system/Thread.h | 4 ++-- 21 files changed, 31 insertions(+), 31 deletions(-) diff --git a/src/basics/Vector3.h b/src/basics/Vector3.h index 0776581..9c5fa8f 100644 --- a/src/basics/Vector3.h +++ b/src/basics/Vector3.h @@ -60,7 +60,7 @@ class BASICSSHARED_EXPORT Vector3 { Vector3 crossProduct(const Vector3 &other) const; /** - * Get the mid-point of the segment between *this* point and *other*. + * Get the mid-point of the segment between 'this' point and 'other'. */ Vector3 midPointTo(const Vector3 &other) const; @@ -69,7 +69,7 @@ class BASICSSHARED_EXPORT Vector3 { /** * Produce a random vector in a sphere domain. * - * If *only_surface* is true, produce a vector with *radius* as length. + * If 'only_surface' is true, produce a vector with 'radius' as length. */ static Vector3 randomInSphere(double radius = 1.0, bool only_surface = false, RandomGenerator &random = RandomGeneratorDefault); diff --git a/src/definition/DefinitionNode.h b/src/definition/DefinitionNode.h index 69a5a27..c2eff42 100644 --- a/src/definition/DefinitionNode.h +++ b/src/definition/DefinitionNode.h @@ -69,7 +69,7 @@ class DEFINITIONSHARED_EXPORT DefinitionNode { * * All internal node modifications should be done using this method, to be reversible. * - * If *backward* is true, the diff will be reversed, instead of applied. + * If 'backward' is true, the diff will be reversed, instead of applied. * * Return true if the diff could be applied. */ @@ -87,7 +87,7 @@ class DEFINITIONSHARED_EXPORT DefinitionNode { * * The watcher will receive DefinitionDiff objects when this node changes. * - * If *init_diff* is set to true, a first diff (or several) will be be pushed immediately to initialize the state. + * If 'init_diff' is set to true, a first diff (or several) will be be pushed immediately to initialize the state. */ void addWatcher(DefinitionWatcher *watcher, bool init_diff = false); @@ -114,7 +114,7 @@ class DEFINITIONSHARED_EXPORT DefinitionNode { * * The manager will take immediate ownership of the diff, handling its freeing. * - * The manager will decide if the diff should be committed and will call *applyDiff* if needed. + * The manager will decide if the diff should be committed and will call 'applyDiff' if needed. */ void addDiff(const DefinitionDiff *diff); diff --git a/src/definition/TimeManager.h b/src/definition/TimeManager.h index 5237931..eb2a58c 100644 --- a/src/definition/TimeManager.h +++ b/src/definition/TimeManager.h @@ -14,7 +14,7 @@ class DEFINITIONSHARED_EXPORT TimeManager { TimeManager(); /** - * Alter a scenery to simulate the passing of *amount* of time. + * Alter a scenery to simulate the passing of 'amount' of time. * * A 1.0 amount is a full day. */ diff --git a/src/definition/VegetationPresenceDefinition.h b/src/definition/VegetationPresenceDefinition.h index c64aa5f..81f4a51 100644 --- a/src/definition/VegetationPresenceDefinition.h +++ b/src/definition/VegetationPresenceDefinition.h @@ -18,7 +18,7 @@ class DEFINITIONSHARED_EXPORT VegetationPresenceDefinition : public DefinitionNo /** * Collect instances in a rectangle area. * - * If *outcomers* is true, the rectangle area will be expanded to included potential instances that does not + * If 'outcomers' is true, the rectangle area will be expanded to included potential instances that does not *originate * in the area, but may have leaves in it. * diff --git a/src/interface/modeler/BaseModelerTool.h b/src/interface/modeler/BaseModelerTool.h index d6c9406..29152e8 100644 --- a/src/interface/modeler/BaseModelerTool.h +++ b/src/interface/modeler/BaseModelerTool.h @@ -18,14 +18,14 @@ class BaseModelerTool : public DefinitionWatcher { /** * Add an automated two-way binding between a QML int property and a scenery IntNode. * - * If *monitor* is true, this tool will also receive the node changes, via the DefinitionWatcher mechanism. + * If 'monitor' is true, this tool will also receive the node changes, via the DefinitionWatcher mechanism. */ void addIntBinding(const string &object, const string &property, const string &path, bool monitor = false); /** * Add an automated two-way binding between a QML int property and a scenery IntNode. * - * If *monitor* is true, this tool will also receive the node changes, via the DefinitionWatcher mechanism. + * If 'monitor' is true, this tool will also receive the node changes, via the DefinitionWatcher mechanism. */ void addFloatBinding(const string &object, const string &property, const string &path, bool monitor = false); diff --git a/src/interface/modeler/ModelerCameras.h b/src/interface/modeler/ModelerCameras.h index a1035fc..3ac78b1 100644 --- a/src/interface/modeler/ModelerCameras.h +++ b/src/interface/modeler/ModelerCameras.h @@ -37,7 +37,7 @@ class ModelerCameras : public QObject, public DefinitionWatcher { /** * Start a sun tool, the camera will follow the sun. * - * *duration* is the duration in milliseconds before calling endTool() automatically (0 to disable to wait for + * 'duration' is the duration in milliseconds before calling endTool() automatically (0 to disable to wait for *manual call). */ void startSunTool(unsigned long duration = 0); diff --git a/src/render/opengl/OpenGLRenderer.h b/src/render/opengl/OpenGLRenderer.h index 2040140..bafbd9e 100644 --- a/src/render/opengl/OpenGLRenderer.h +++ b/src/render/opengl/OpenGLRenderer.h @@ -48,7 +48,7 @@ class OPENGLSHARED_EXPORT OpenGLRenderer : public SoftwareRenderer { /** * Check for errors in OpenGL context. * - * Will write the error on standard error output, with the *domain* specified. + * Will write the error on standard error output, with the 'domain' specified. */ void checkForErrors(const string &domain); diff --git a/src/render/opengl/OpenGLShaderProgram.h b/src/render/opengl/OpenGLShaderProgram.h index c75e8f7..9dbd5b7 100644 --- a/src/render/opengl/OpenGLShaderProgram.h +++ b/src/render/opengl/OpenGLShaderProgram.h @@ -31,7 +31,7 @@ class OPENGLSHARED_EXPORT OpenGLShaderProgram { * This will bind the program (compile it if needed), set the uniform variables, and * ask the array object to bind its VAO and render itself. * - * *state* is optional and may add ponctual variables to the global state. + * 'state' is optional and may add ponctual variables to the global state. */ void draw(OpenGLVertexArray *vertices, OpenGLSharedState *state = NULL, int start = 0, int count = -1); diff --git a/src/render/opengl/OpenGLTerrainChunk.cpp b/src/render/opengl/OpenGLTerrainChunk.cpp index 999100d..5ace15a 100644 --- a/src/render/opengl/OpenGLTerrainChunk.cpp +++ b/src/render/opengl/OpenGLTerrainChunk.cpp @@ -177,7 +177,7 @@ void OpenGLTerrainChunk::render(OpenGLShaderProgram *program) { } _lock_data->release(); - // FIXME Should update *vertices* inside lock + // FIXME Should update 'vertices' inside lock program->draw(vertices, glstate); } diff --git a/src/render/opengl/OpenGLTerrainChunk.h b/src/render/opengl/OpenGLTerrainChunk.h index 5732e65..7383d36 100644 --- a/src/render/opengl/OpenGLTerrainChunk.h +++ b/src/render/opengl/OpenGLTerrainChunk.h @@ -39,24 +39,24 @@ class OPENGLSHARED_EXPORT OpenGLTerrainChunk { void destroy(OpenGLFunctions *functions); /** - * Fill *vertices* with a quick initial set of vertices, that can be augmented later using *augmentVertices*. + * Fill 'vertices' with a quick initial set of vertices, that can be augmented later using 'augmentVertices'. */ void setFirstStepVertices(); /** - * Improve the level of detail of tessellated vertices in *vertices*. + * Improve the level of detail of tessellated vertices in 'vertices'. * * This will double the existing resolution. */ void augmentVertices(); /** - * Update *vertices* using *source*. + * Update 'vertices' using 'source'. */ void updateVertices(const OpenGLVertexArray &source, int vertice_level); /** - * Set a square (two triangles) in *vertices_next*. + * Set a square (two triangles) in 'vertices_next'. */ void fillVerticesFromSquare(OpenGLVertexArray *array, int index_offset, double x, double z, double size); diff --git a/src/render/opengl/OpenGLVariable.h b/src/render/opengl/OpenGLVariable.h index 291b30c..f7db969 100644 --- a/src/render/opengl/OpenGLVariable.h +++ b/src/render/opengl/OpenGLVariable.h @@ -21,7 +21,7 @@ class OpenGLVariable final { /** * Apply the variable to the bound shader program. * - * *texture_unit* will be used and updated accordingly. + * 'texture_unit' will be used and updated accordingly. * * This must be called from the rendering thread, with the shader program bound. */ diff --git a/src/render/opengl/OpenGLVegetation.h b/src/render/opengl/OpenGLVegetation.h index c150eda..5aa3002 100644 --- a/src/render/opengl/OpenGLVegetation.h +++ b/src/render/opengl/OpenGLVegetation.h @@ -69,7 +69,7 @@ class OPENGLSHARED_EXPORT OpenGLVegetation : public OpenGLPart, public Definitio void setEnabled(bool enabled); /** - * Update the *layers* member from the scenery. + * Update the 'layers' member from the scenery. * * This will create missing layers, and mark extraneous ones for deletion. * This will not update existing layers (they should update themselves by watching their definition). diff --git a/src/render/opengl/OpenGLVegetationLayer.h b/src/render/opengl/OpenGLVegetationLayer.h index 76f70d2..a13cbdc 100644 --- a/src/render/opengl/OpenGLVegetationLayer.h +++ b/src/render/opengl/OpenGLVegetationLayer.h @@ -21,7 +21,7 @@ class OPENGLSHARED_EXPORT OpenGLVegetationLayer { } /** - * Collect instances in a given area, and add them to the array *instances*. + * Collect instances in a given area, and add them to the array 'instances'. * * The array is not checked for already present instances. */ diff --git a/src/render/software/FluidMediumManager.h b/src/render/software/FluidMediumManager.h index 8ac292d..d8724b4 100644 --- a/src/render/software/FluidMediumManager.h +++ b/src/render/software/FluidMediumManager.h @@ -38,7 +38,7 @@ class SOFTWARESHARED_EXPORT FluidMediumManager { void registerMedium(FluidMediumInterface *medium); /** - * Apply complete medium traversal between *location* and *eye*, to the base *color*. + * Apply complete medium traversal between 'location' and 'eye', to the base 'color'. * * Returns the light received by eye, transformed by medium traversal. */ diff --git a/src/render/software/GodRaysSampler.h b/src/render/software/GodRaysSampler.h index a1e1c1e..7fb16f7 100644 --- a/src/render/software/GodRaysSampler.h +++ b/src/render/software/GodRaysSampler.h @@ -94,8 +94,8 @@ class SOFTWARESHARED_EXPORT GodRaysSampler { /** * Apply the god rays effect to a location. * - * *raw* is the shaded color, without atmospheric effects. - * *atmosphered* is the shaded color, with atmospheric effects applied. + * 'raw' is the shaded color, without atmospheric effects. + * 'atmosphered' is the shaded color, with atmospheric effects applied. */ Color apply(const Color &raw, const Color &atmosphered, const Vector3 &location); diff --git a/src/render/software/LightSource.h b/src/render/software/LightSource.h index d2f3b54..60b2a2b 100644 --- a/src/render/software/LightSource.h +++ b/src/render/software/LightSource.h @@ -18,7 +18,7 @@ class SOFTWARESHARED_EXPORT LightSource { /** * Get the list of raw lights that may be applied at a given location. * - * Returns true if lights were added to *result*. + * Returns true if lights were added to 'result'. */ virtual bool getLightsAt(vector &result, const Vector3 &location) const = 0; }; diff --git a/src/render/software/NightSky.h b/src/render/software/NightSky.h index 889d578..09cc9b2 100644 --- a/src/render/software/NightSky.h +++ b/src/render/software/NightSky.h @@ -24,7 +24,7 @@ class SOFTWARESHARED_EXPORT NightSky : public LightSource { /** * Get the color of the night sky at a given direction. * - * *altitude* is above water level, in coordinate units (not kilometers). + * 'altitude' is above water level, in coordinate units (not kilometers). */ virtual const Color getColor(double altitude, const Vector3 &direction); diff --git a/src/render/software/TerrainRasterizer.h b/src/render/software/TerrainRasterizer.h index c70f112..e38af5e 100644 --- a/src/render/software/TerrainRasterizer.h +++ b/src/render/software/TerrainRasterizer.h @@ -57,7 +57,7 @@ class SOFTWARESHARED_EXPORT TerrainRasterizer : public Rasterizer { * * Return the number of quads that has been pushed. * - * *canvas* may be NULL to only simulate the tessellation. + * 'canvas' may be NULL to only simulate the tessellation. */ int performTessellation(CanvasPortion *canvas, bool displaced); diff --git a/src/render/software/VegetationRenderer.h b/src/render/software/VegetationRenderer.h index 41efad2..8972e4a 100644 --- a/src/render/software/VegetationRenderer.h +++ b/src/render/software/VegetationRenderer.h @@ -25,9 +25,9 @@ class SOFTWARESHARED_EXPORT VegetationRenderer : public LightFilter { /** * Perform ray casting on a single instance. * - * If *only_hit* is true, only care about hitting or not, do not compute the color. + * If 'only_hit' is true, only care about hitting or not, do not compute the color. * - * If *displaced* is true, *instance* is considered on already displaced terrain, else, terrain displacement is + * If 'displaced' is true, 'instance' is considered on already displaced terrain, else, terrain displacement is *applied. */ RayCastingResult renderInstance(const SpaceSegment &segment, const VegetationInstance &instance, diff --git a/src/system/PackStream.h b/src/system/PackStream.h index 5086821..6258996 100644 --- a/src/system/PackStream.h +++ b/src/system/PackStream.h @@ -39,7 +39,7 @@ class SYSTEMSHARED_EXPORT PackStream { * * The other stream must not have been bound to a file (still a memory buffer). * - * If *prepend_size* is true, an integer will be written on front with the number of bytes written. + * If 'prepend_size' is true, an integer will be written on front with the number of bytes written. */ void writeFromBuffer(const PackStream &other, bool prepend_size = false); diff --git a/src/system/Thread.h b/src/system/Thread.h index 96fd96f..d7d4231 100644 --- a/src/system/Thread.h +++ b/src/system/Thread.h @@ -19,8 +19,8 @@ class SYSTEMSHARED_EXPORT Thread : private QThread { * * The thread is not started automatically. A call to method start() needs to be done. * - * Either the *function* argument should be provided (with the function to call from the - * thread), or the *run* method overridden. + * Either the 'function' argument should be provided (with the function to call from the + * thread), or the 'run' method overridden. */ Thread(ThreadFunction function = 0);