Vladimír Vondruš
ce5276b7f0
Doxygen: create tag file.
...
Turned off INLINE_SIMPLE_STRUCTS, as it causes bugs in the tagfile.
14 years ago
Vladimír Vondruš
c2b1b78916
Added examples to the documentation.
...
Repository magnum-examples must be next to magnum repository to build
the complete documentation.
14 years ago
Vladimír Vondruš
7501c14e56
Exclude *Visibility.h files from documentation.
14 years ago
Vladimír Vondruš
f9216b99b0
SVG graphs, using Verdana like rest of the documentation.
14 years ago
Vladimír Vondruš
326c373db6
Don't show #includes in file documentation.
...
Another unneded information.
14 years ago
Vladimír Vondruš
7712505f7c
Inlining simple structures in documentation.
14 years ago
Vladimír Vondruš
4a4ba9425c
Show template relations for classes.
...
Displays the subclassing hierarchy also for Vector and Matrix templated
classes.
14 years ago
Vladimír Vondruš
876254efcd
Custom @collisionoperator command instead of hiding the functions.
...
Uses @relates , so the collision operator is tied to class for which the
collision is implemented (not to which contains the implementation).
14 years ago
Vladimír Vondruš
208b6ce93e
Custom @debugoperator command instead of hiding the functions.
...
Uses @relates , so the operator is tied to related class.
14 years ago
Vladimír Vondruš
53a5fa8454
Removed bloated include hierarchy graphs from file documentation.
...
It was unneeded anyway, the only purpose I can think of is to showcase
those pretty graphs, nothing more.
14 years ago
Vladimír Vondruš
fcf0612c10
Absolute include paths in documentation.
...
Currently it was incorrectly stated that for using Math::Matrix or for
example Trade::MeshData it was sufficient to
#include <Matrix.h>
#include <MeshData.h>
which was obviously wrong, as Math/ (nor any other namespace-related
subdirectory) is not on include path. Now it states correctly that a
directory prefix is needed:
#include <Math/Matrix.h>
#include <Trade/MeshData.h>
The same is now fixed for classes in magnum-plugins repository.
14 years ago
Vladimír Vondruš
c1fad30934
Users don't (and shouldn't) care about friend declarations in docs.
14 years ago
Vladimír Vondruš
9ece394566
Less columns for alphabetical class index.
14 years ago
Vladimír Vondruš
d3e684c42b
Include doc/ subdir of magnum-plugins into documentation.
14 years ago
Vladimír Vondruš
05ed802975
Doxygen command @todoc for documentation-related todos.
14 years ago
Vladimír Vondruš
0b45da1b07
Quiet (warnings only) Doxygen output.
14 years ago
Vladimír Vondruš
a92b4698fa
Doxyfile: building documentation also for magnum-plugins.
...
The repository with magnum-plugins must be next to this repository to
make documentation building possible.
14 years ago
Vladimír Vondruš
8871334ed2
Updated Doxyfile for Doxygen 1.8.1.
...
Doxygen produces some false-positive warnings for Matrix and Vector
classes, but the generated documentation is fine. Worked around the
warnings by using @copybrief and @copydetails instead of @copydoc .
14 years ago
Vladimír Vondruš
63a96f4cda
Documentation: support for functionality requiring specific extensions.
14 years ago
Vladimír Vondruš
3f4e28cfca
Documented required OpenGL version for some functionality.
...
The requirements are cross-referenced to dedicated page, similarly to
TODO and bug lists.
Also updated / improved documentation for some texture / image formats.
14 years ago
Vladimír Vondruš
c5b38c9f1a
Documented Matrix and Vector algorithms.
14 years ago
Vladimír Vondruš
1cf69616a3
Documentation updates, "markdownization".
...
All HTML code and Doxygen shortcuts such as @c , @b and @em are now
rewritten using Markdown syntax, which makes it more readable.
Also updated Doxyfile. Doxygen 1.8 at least is required to generate
the documentation now.
14 years ago
Vladimír Vondruš
80a10c9e6c
Doc++
15 years ago
Vladimír Vondruš
5556b75e88
Doxyfile update.
15 years ago
Vladimír Vondruš
b31cb47e1c
Macro for hiding code from being improperly handled by Doxygen.
16 years ago
Vladimír Vondruš
95ae231e6d
Really exclude test directories from documentation.
16 years ago
Vladimír Vondruš
ba12926f29
Added Doxyfile
16 years ago