Vladimír Vondruš
99c72ed99b
Initial support for OpenGL 4.4.
13 years ago
Vladimír Vondruš
8453d01ffe
Added section for ES2-compatibility-only features into documentation.
13 years ago
Vladimír Vondruš
ab6ee813a1
Updated Doxyfile for Doxygen 1.8.4.
...
Also disabled some new unwanted features.
13 years ago
Vladimír Vondruš
8ed0d15bc9
Don't sort member docs in Doxygen so \overload works as expected.
13 years ago
Vladimír Vondruš
7ef8432fbe
Doxygen: ignore specific namespaces instead of whole directories.
...
Less maintenance burden with `#ifndef DOXYGEN_GENERATING_OUTPUT`,
removed the ones which are not needed anymore.
13 years ago
Vladimír Vondruš
c00f081b83
Using larger font in Doxygen documentation formulas.
13 years ago
Vladimír Vondruš
19e0302b6f
Don't render bloated and scary inheritance graphs in documentation.
...
Just pretend that everything is shiny and following KISS principle.
13 years ago
Vladimír Vondruš
77068a1810
Added alias for linking to ES extension functions to Doxyfile.
14 years ago
Vladimír Vondruš
02267d1439
Doxygen configuration.
...
* Don't extract local classes.
* Don't include header code in documentation (the only purpose would be
to scare users off).
* Include template implementation files in documentation.
14 years ago
Vladimír Vondruš
1db86e7388
Updated Doxygen commands for OpenGL ES, mentioned them in coding style.
14 years ago
Vladimír Vondruš
6278db11e2
Don't show links to extension functions in non-proportional font.
14 years ago
Vladimír Vondruš
df836f126d
Ability to link to extension functions in Doxygen documentation.
14 years ago
Vladimír Vondruš
a0f79fcf78
Don't parse Implementation/ directories with Doxygen.
...
These are even more "private" versions of Implementation namespace in
public headers, so we don't need to generate public documentation for
them.
14 years ago
Vladimír Vondruš
035bd4d376
Links to documentation of related gl*() function.
...
Each function touching OpenGL now has list of all related functions
touching OpenGL.
14 years ago
Vladimír Vondruš
0e74c3847d
Support for storing matrices and vectors in configuration.
14 years ago
Vladimír Vondruš
1ade64ca6b
New crossreferenced @debugoperator alias.
14 years ago
Vladimír Vondruš
68872b03cf
Added @requires_{gl43,gles30,es_extension} Doxygen aliases.
14 years ago
Vladimír Vondruš
8456609119
Mention only OpenGL ES (without version).
14 years ago
Vladimír Vondruš
c7bb153d0a
Port to OpenGL ES 2.
...
Desktop OpenGL and OpenGL ES 2 support can be switched using CMake
TARGET_GLES option. All functionality not supported in ES is marked in
documentation.
If targetting OpenGL ES, GLES2/gl2.h is included instead of GLEW.
Mesh class now uses VAOs only in desktop OpenGL, in ES the buffers are
bound on each draw call.
14 years ago
Vladimír Vondruš
b931c83309
Using tagfile from Corrade documentation.
...
Workaround to avoid clash with Corrade's TypeTraits.h.
14 years ago
Vladimír Vondruš
c11b397d3f
Documentation update.
...
* All pages are now named with lowercased letters with dashes between
letters.
* Added coding style guidelines.
* Extended building documentation with guide how to download Magnum.
14 years ago
Vladimír Vondruš
5133861750
Links to required extensions in documentation.
...
Fixed a few typos in extension names, fixed BPTC texture compression
typos. Removed redundant EXT_framebuffer_object from functions as the
Framebuffer class itself has it.
14 years ago
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