DOCS: updated doxygen template and markdown
Martin Gerhardy
parent
c262a93b20
commit
6057f54299
|
|
@ -234,8 +234,8 @@ configure_file(src/engine-config.h.in engine-config.h @ONLY)
|
|||
message(STATUS "Generate config.h in ${CMAKE_CURRENT_BINARY_DIR}")
|
||||
|
||||
find_package(Doxygen)
|
||||
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
||||
if (DOXYGEN_FOUND)
|
||||
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
|
||||
add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
||||
COMMENT "Generating API documentation with Doxygen" VERBATIM
|
||||
|
|
|
|||
|
|
@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
|
|||
# title of most generated pages and in a few other places.
|
||||
# The default value is: My Project.
|
||||
|
||||
PROJECT_NAME = "Voxel Engine"
|
||||
PROJECT_NAME = "@ROOT_PROJECT_NAME@"
|
||||
|
||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER =
|
||||
PROJECT_NUMBER = "@ROOT_PROJECT_VERSION@"
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer a
|
||||
|
|
@ -152,7 +152,7 @@ FULL_PATH_NAMES = YES
|
|||
# will be relative from the directory where doxygen is started.
|
||||
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
|
||||
|
||||
STRIP_FROM_PATH =
|
||||
STRIP_FROM_PATH = @ROOT_DIR@
|
||||
|
||||
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
|
||||
# path mentioned in the documentation of a class, which tells the reader which
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
# General
|
||||
# Server
|
||||
|
||||
## General
|
||||
|
||||
TODO: document server architecture
|
||||
|
||||
# Docker
|
||||
## Docker
|
||||
|
||||
The docker image is using apt-cacher-ng (https://github.com/sameersbn/docker-apt-cacher-ng)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,6 @@
|
|||
# About
|
||||
# Traze
|
||||
|
||||
## About
|
||||
|
||||
This is a voxel based representation of the traze game available at [traze.iteratec.de](https://traze.iteratec.de).
|
||||
|
||||
|
|
@ -8,7 +10,7 @@ This application can be used to spectate games and to play games. You can select
|
|||
select one and decide at any time to join the game by hitting the button in the debug menu. Once you press the first WASD-key
|
||||
to move your bike, you are joined.
|
||||
|
||||
# TODO
|
||||
## TODO
|
||||
|
||||
* add scoreboard menu
|
||||
* player explosions
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Purpose
|
||||
# CompuseShaderTool
|
||||
|
||||
This tool parses OpenCL shader files (`*.cl`) and generates C++ source files for them.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,6 @@
|
|||
# Table descriptions for the databasetool.
|
||||
# Databasetool
|
||||
|
||||
## Table descriptions for the databasetool.
|
||||
|
||||
The databasetool binary will generate model files for the
|
||||
table definitions given in `*.tbl` files. You can specify the fields,
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# General
|
||||
# MapEdit
|
||||
|
||||
The `mapedit` tool is the tool to build maps. Not by placing voxel per voxel, but just
|
||||
by putting entities into the void with parameters to procedurally generate the surface.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,13 @@
|
|||
# Purpose
|
||||
# Voxedit
|
||||
|
||||
## Purpose
|
||||
|
||||
Voxel editor for large scenes.
|
||||
|
||||
This editor was written to have a linux voxel editor with animation support for
|
||||
my own engine and evolved into something that others might find useful, too.
|
||||
|
||||
# Features
|
||||
## Features
|
||||
|
||||
* Large scene support
|
||||
* Load vox, qbt, qb, vxm
|
||||
|
|
@ -34,7 +36,7 @@ my own engine and evolved into something that others might find useful, too.
|
|||
* Rotate around reference position or center of volume
|
||||
* Import bitmaps as plane
|
||||
|
||||
# Controls
|
||||
## Controls
|
||||
|
||||
* Placing voxels via left mouse button
|
||||
* Deleting voxels via right mouse button
|
||||
|
|
@ -45,7 +47,7 @@ my own engine and evolved into something that others might find useful, too.
|
|||
* Enter places the reference position at the current cursor position
|
||||
* Shift+Tab opens the console (type cmdlist and cvarlist)
|
||||
|
||||
# Planned
|
||||
## Planned
|
||||
|
||||
* SceneSettings dialog
|
||||
- Set bitmap backgrounds for each axis on a plane at a given position
|
||||
|
|
@ -71,7 +73,7 @@ my own engine and evolved into something that others might find useful, too.
|
|||
* Physics
|
||||
* Particle emitter
|
||||
|
||||
# Needed improvements
|
||||
## Needed improvements
|
||||
|
||||
* Fix memento states for merge of layers
|
||||
* Fix memento states for layer group modifications
|
||||
|
|
|
|||
Loading…
Reference in New Issue