enh: add metadata and logo to Doxygen docs

NeuroML · Mar 11, 2021 · c9af3d8 · c9af3d8
1 parent adad351
commit c9af3d8
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -10,7 +10,11 @@ cmake_policy(SET CMP0042 NEW) # Mac OS @rpath
 cmake_policy(SET CMP0048 NEW) # VERSION option to project()
 
 # Note: the version number uses Semantic Versioning http://semver.org/
-project(NeuroML_API VERSION 2.1.0)
+project(NeuroML_API
+    VERSION 2.1.0
+    DESCRIPTION "C++ API for NeuroML 2"
+    HOMEPAGE_URL "https://github.com/NeuroML/NeuroML_API"
+    )
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR}/cmake/modules)
 
 # Developer settable options

diff --git a/Doxyfile.in b/Doxyfile.in
@@ -38,20 +38,20 @@ PROJECT_NAME           = "NeuroML C++ API"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = "@CMAKE_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
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          =
+PROJECT_BRIEF          = "@CMAKE_PROJECT_DESCRIPTION@"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = "@CMAKE_SOURCE_DIR@/neuroml_logo.png"
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is

diff --git a/neuroml_logo.png b/neuroml_logo.png