From 62059079cd0b59537515b0df87aa3217138b267a Mon Sep 17 00:00:00 2001 From: Dane Johnson Date: Tue, 26 Jan 2021 22:04:57 -0600 Subject: [PATCH] More docs --- core/CMakeLists.txt | 5 ++--- core/Node.cpp | 24 ++++++++++++++++++++++++ core/Node.h | 3 ++- core/mainpage.dox | 3 +++ 4 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 core/mainpage.dox diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt index d3717bb..019c0c1 100644 --- a/core/CMakeLists.txt +++ b/core/CMakeLists.txt @@ -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) diff --git a/core/Node.cpp b/core/Node.cpp index ff0bbe5..2dbbdb9 100644 --- a/core/Node.cpp +++ b/core/Node.cpp @@ -1,3 +1,27 @@ +/** + @file + @author Dane Johnson + + @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" diff --git a/core/Node.h b/core/Node.h index 13aa358..e580393 100644 --- a/core/Node.h +++ b/core/Node.h @@ -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 diff --git a/core/mainpage.dox b/core/mainpage.dox new file mode 100644 index 0000000..0260b01 --- /dev/null +++ b/core/mainpage.dox @@ -0,0 +1,3 @@ +/** + @mainpage Couch: the Last Bastion of Co-operative Interactive Arts + */