diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2017-09-02 12:34:14 +0100 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2017-09-02 12:34:37 +0100 |
commit | 66db2c1bf2ef99986f4d75a27b30756dc21e3426 (patch) | |
tree | 6d4e0452e39c525c628fe6632fa6db1d2f9f05e1 /docs | |
parent | 120210b588959fa8e5466e04443c31a2e6a96292 (diff) | |
download | YAGE-66db2c1bf2ef99986f4d75a27b30756dc21e3426.tar.gz YAGE-66db2c1bf2ef99986f4d75a27b30756dc21e3426.zip |
Improving todolist and adding it to doxygen
Diffstat (limited to 'docs')
-rw-r--r-- | docs/todolist.dox | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/todolist.dox b/docs/todolist.dox new file mode 100644 index 00000000..b4ee3ac0 --- /dev/null +++ b/docs/todolist.dox @@ -0,0 +1,25 @@ +/** @todo +# Add comments + +## Reason +Currently there are no comments in the code. They should be added so that in the future the code +can be edited easily and improved without having to know the exact implementation of every function. + +## Requirements +- It should follow the doxygen API so that documentation can easily be generated. + +*/ + +/** @todo + +# Switch GPU API + +## Reason +Vulkan is much more straight forward and it should be easier to understand OpenGL from it. I +also the newest API that will be used in the newest games and is supported by quite a few +graphics cards. + +## Requirements +- yage shouldn't depend on GL anymore and exclusively use Vulkan libraries. + +*/ |