More docs

This commit is contained in:
Dane Johnson 2021-01-26 22:04:57 -06:00
parent d2b6aafce5
commit 62059079cd
4 changed files with 31 additions and 4 deletions

View File

@ -80,7 +80,6 @@ target_link_libraries(couchlib ${BULLET_LIBRARIES})
## Add documentation
find_package(Doxygen REQUIRED
OPTIONAL_COMPONENTS dot mscgen dia)
doxygen_add_docs(couchdocs
Node.h)
.
mainpage.dox)

View File

@ -1,3 +1,27 @@
/**
@file
@author Dane Johnson <dane@danejohnson.org>
@section LICENSE
Couch Copyright (C) 2021 Dane Johnson
This program comes with ABSOLUTELY NO WARRANTY; without event the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for details at
https://www.gnu.org/licenses/gpl-3.0.html
This is free software, and you are welcome to redistribute it
under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3 of the License,
or (at your option) any later version.
@section DESCRIPTION
Node is the parent class for all classes that would be in the scene
tree. The root of the scene tree is always a node.
*/
#include "Node.h"
#include "Util.h"

View File

@ -5,9 +5,10 @@
@section LICENSE
Couch Copyright (C) 2021 Dane Johnson
This program comes with ABSOLUTELY NO WARRANTY; without event the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public LICENSE for details at
See the GNU General Public License for details at
https://www.gnu.org/licenses/gpl-3.0.html
This is free software, and you are welcome to redistribute it

3
core/mainpage.dox Normal file
View File

@ -0,0 +1,3 @@
/**
@mainpage Couch: the Last Bastion of Co-operative Interactive Arts
*/