Commit 2d4d596e authored by VAN TOLL Wouter's avatar VAN TOLL Wouter
Browse files

Documentation: Fixed Doxygen warnings, updated readme.

parent c09204f9
......@@ -829,7 +829,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = include src doc README.md
INPUT = src doc README.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......
......@@ -7,7 +7,7 @@ UMANS (Unified Microscopic Agent Navigation Simulator)
Many algorithms for microscopic crowd simulation have been developed over the past decades. However, each implementation has its own settings and details that can greatly influence the results. The purpose of UMANS is to reproduce as many existing algorithms as possible via one principle, while unifying as many overall settings as possible. This allows for a more honest and meaningful comparison of simulation algorithms.
UMANS was previously known as OCSR (Open Crowd Simulation Resources). Some parts of the project may still use this old name. Since 2020, the term "[OCSR](https://project.inria.fr/crowdscience/project/ocsr/)" refers to the collective of open crowd-simulation resources developed at Inria Rennes. These resources include UMANS (a simulation engine) and [ChAOS](https://project.inria.fr/crowdscience/project/ocsr/chaos/) (a visualization application).
UMANS was previously known as OCSR (Open Crowd Simulation Resources). Some parts of the project may still use this old name. Since 2020, the term [OCSR](https://project.inria.fr/crowdscience/project/ocsr/) refers to the collective of open crowd-simulation resources developed at Inria Rennes. These resources include UMANS (a simulation engine) and [ChAOS](https://project.inria.fr/crowdscience/project/ocsr/chaos/) (a visualization application).
UMANS is primarily meant for the scientific community, as a unified tool for experimenting with different navigation algorithms. However, the tool can be used freely by everyone, and it does not require any programming knowledge.
......@@ -23,7 +23,7 @@ You can mix and match these elements as you wish. No programming knowledge is re
### What can UMANS *not* do?
* **Global path planning:** The UMANS library deliberately focuses on *local navigation only*, i.e. the local interactions between agents.
The simulation environment may contain static obstacles, but the agents in UMANS *do not* plan a global path.
The simulation environment may contain static obstacles, but the agents in UMANS *do not* plan a global path around these obstacles.
* **Fancy visualization:** UMANS focuses on the simulation itself. For nice 3D animations of a crowd, consider using separate programs such as [ChAOS](https://project.inria.fr/crowdscience/project/ocsr/chaos/).
# Reference
......
......@@ -190,9 +190,10 @@ public:
/// <summary>Overrides the velocity and viewing direction of this agent with the given values,
/// for example computed by an external application.</summary>
/// <remarks>Note: This us not the usual way to change the agent's velocity.
/// <remarks>Note: This is not the usual way to change the agent's velocity.
/// Only use this if you wish to override the agent's standard motion mechanism.</remarks>
/// <param name="position">The new position of the agent.</param>
/// <param name="velocity">The new velocity of the agent.</param>
/// <param name="viewingDirection">The new viewing direction of the agent.</param>
void setVelocity_ExternalApplication(const Vector2D& velocity, const Vector2D& viewingDirection);
/// <summary>Sets the goal position of this agent to the given value, and possibly updates the agent's viewing direction.</summary>
......
......@@ -125,7 +125,7 @@ private:
public:
/// <summary>Creates a Policy with the given details.</summary>
/// <param name="method">The optimization method that this policy should use.</param>
/// <param name="samplingParameters">The sampling parameters that this policy should use.
/// <param name="params">The sampling parameters that this policy should use.
/// Only used if the optimization method is OptimizationMethod::SAMPLING.</param>
Policy(OptimizationMethod method, SamplingParameters params)
: optimizationMethod_(method), samplingParameters_(params) {}
......
......@@ -236,7 +236,7 @@ protected:
/// <param name="queryingAgent">A pointer to the Agent object performing the query. This agent will be excluded from the results.
/// Use nullptr to not exclude any agents.</param>
/// <param name="result">[out] Will store a list of pointers to agents queryingAgent lie within "search_radius" meters of "position",
/// excluding the agent denoted by "queryingAgent" (if it exists).</returns>
/// excluding the agent denoted by "queryingAgent" (if it exists).</param>
void computeNeighboringAgents_Flat(const Vector2D& position, float search_radius, const Agent* queryingAgent, std::vector<const Agent*>& result) const;
void computeNeighboringObstacles_Flat(const Vector2D& position, float search_radius, std::vector<LineSegment2D>& result) const;
......
......@@ -54,7 +54,7 @@ public:
: a11_(v1.x), a12_(v2.x), a21_(v1.y), a22_(v2.y) {}
/// <summary>Computes and returns the transposed version of this Matrix.</summary>
/// <returns>A Matrix object similar to the current one, but with a21 and a12 swapped.</return>
/// <returns>A Matrix object similar to the current one, but with a21 and a12 swapped.</returns>
inline Matrix GetTransposed() const
{
return Matrix(a11_, a21_, a12_, a22_);
......
......@@ -60,7 +60,7 @@ private:
public:
/// <summary>Creates a CSVWriter object.</summary>
/// <param name="flushImmediately">Whether or not this CSVWriter should immediately call Flush() at the end of each call to AppendAgentPositions().</summary>
/// <param name="flushImmediately">Whether or not this CSVWriter should immediately call Flush() at the end of each call to AppendAgentPositions().</param>
CSVWriter(bool flushImmediately) : flushImmediately(flushImmediately) {}
/// <summary>Tries to set the directory to which CSV output files will be written.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment