mirror of
https://github.com/bensuperpc/astar.git
synced 2025-06-23 01:03:34 +02:00
32
docs/Doxyfile.in
Normal file
32
docs/Doxyfile.in
Normal file
@ -0,0 +1,32 @@
|
||||
# Configuration for Doxygen for use with CMake
|
||||
# Only options that deviate from the default are included
|
||||
# To create a new Doxyfile containing all available options, call `doxygen -g`
|
||||
|
||||
# Get Project name and version from CMake
|
||||
PROJECT_NAME = "@PROJECT_NAME@"
|
||||
PROJECT_NUMBER = "@PROJECT_VERSION@"
|
||||
|
||||
# Add sources
|
||||
INPUT = "@PROJECT_SOURCE_DIR@/README.md" "@PROJECT_SOURCE_DIR@/include" "@PROJECT_SOURCE_DIR@/docs/pages"
|
||||
EXTRACT_ALL = YES
|
||||
RECURSIVE = YES
|
||||
OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIRECTORY@"
|
||||
|
||||
# Use the README as a main page
|
||||
USE_MDFILE_AS_MAINPAGE = "@PROJECT_SOURCE_DIR@/README.md"
|
||||
|
||||
# set relative include paths
|
||||
FULL_PATH_NAMES = YES
|
||||
STRIP_FROM_PATH = "@PROJECT_SOURCE_DIR@/include" "@PROJECT_SOURCE_DIR@"
|
||||
STRIP_FROM_INC_PATH =
|
||||
|
||||
# We use m.css to generate the html documentation, so we only need XML output
|
||||
GENERATE_XML = YES
|
||||
GENERATE_HTML = NO
|
||||
GENERATE_LATEX = NO
|
||||
XML_PROGRAMLISTING = NO
|
||||
CREATE_SUBDIRS = NO
|
||||
|
||||
# Include all directories, files and namespaces in the documentation
|
||||
# Disable to include only explicitly documented objects
|
||||
M_SHOW_UNDOCUMENTED = YES
|
6
docs/conf.py.in
Normal file
6
docs/conf.py.in
Normal file
@ -0,0 +1,6 @@
|
||||
DOXYFILE = 'Doxyfile'
|
||||
|
||||
LINKS_NAVBAR1 = [
|
||||
(None, 'pages', [(None, 'about')]),
|
||||
(None, 'namespaces', []),
|
||||
]
|
7
docs/pages/about.dox
Normal file
7
docs/pages/about.dox
Normal file
@ -0,0 +1,7 @@
|
||||
/**
|
||||
* @page about About
|
||||
* @section about-doxygen Doxygen documentation
|
||||
* This page is auto generated using
|
||||
* <a href="https://www.doxygen.nl/">Doxygen</a>, making use of some useful
|
||||
* <a href="https://www.doxygen.nl/manual/commands.html">special commands</a>.
|
||||
*/
|
Reference in New Issue
Block a user