Skip to content

Commit c9af3d8

Browse files
committed
enh: add metadata and logo to Doxygen docs
1 parent adad351 commit c9af3d8

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

CMakeLists.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@ cmake_policy(SET CMP0042 NEW) # Mac OS @rpath
1010
cmake_policy(SET CMP0048 NEW) # VERSION option to project()
1111

1212
# Note: the version number uses Semantic Versioning http://semver.org/
13-
project(NeuroML_API VERSION 2.1.0)
13+
project(NeuroML_API
14+
VERSION 2.1.0
15+
DESCRIPTION "C++ API for NeuroML 2"
16+
HOMEPAGE_URL "https://github.com/NeuroML/NeuroML_API"
17+
)
1418
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR}/cmake/modules)
1519

1620
# Developer settable options

Doxyfile.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,20 @@ PROJECT_NAME = "NeuroML C++ API"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER =
41+
PROJECT_NUMBER = "@CMAKE_PROJECT_VERSION@"
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a
4545
# quick idea about the purpose of the project. Keep the description short.
4646

47-
PROJECT_BRIEF =
47+
PROJECT_BRIEF = "@CMAKE_PROJECT_DESCRIPTION@"
4848

4949
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
5050
# in the documentation. The maximum height of the logo should not exceed 55
5151
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
5252
# the logo to the output directory.
5353

54-
PROJECT_LOGO =
54+
PROJECT_LOGO = "@CMAKE_SOURCE_DIR@/neuroml_logo.png"
5555

5656
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5757
# into which the generated documentation will be written. If a relative path is

neuroml_logo.png

13.5 KB
Loading

0 commit comments

Comments
 (0)