summaryrefslogtreecommitdiffstats
path: root/src/math/README.txt
diff options
context:
space:
mode:
authorPiotr Dziwinski <piotrdz@gmail.com>2012-08-11 18:39:16 +0200
committerPiotr Dziwinski <piotrdz@gmail.com>2012-08-11 18:39:16 +0200
commit1996507fd3d4d9de90de99845b71a6bf3fbe62da (patch)
tree6dca78a855a8f0eacb3aecd230d337453ebca2ce /src/math/README.txt
parent7f80ca297154809523cd533edf1842ab1ae391aa (diff)
downloadcolobot-1996507fd3d4d9de90de99845b71a6bf3fbe62da.tar.gz
colobot-1996507fd3d4d9de90de99845b71a6bf3fbe62da.tar.bz2
colobot-1996507fd3d4d9de90de99845b71a6bf3fbe62da.zip
Documentation update
- updated Doxyfile - added/changed file, dir and namespace descriptions - fixed some errors in doxygen tags
Diffstat (limited to 'src/math/README.txt')
-rw-r--r--src/math/README.txt13
1 files changed, 11 insertions, 2 deletions
diff --git a/src/math/README.txt b/src/math/README.txt
index 1a5ce93..fd34dcb 100644
--- a/src/math/README.txt
+++ b/src/math/README.txt
@@ -1,3 +1,12 @@
-src/math
+/**
+ * \dir math
+ * \brief Common mathematical structures and functions
+ */
-Contains common mathematical structures and functions.
+/**
+ * \namespace Math
+ * \brief Namespace for (new) math code
+ *
+ * This namespace was created to avoid clashing with old code, but now it still serves,
+ * defining a border between math and non-math-related code.
+ */ \ No newline at end of file