From aac5215c033414bb619e1bde4e8e9504ed8998da Mon Sep 17 00:00:00 2001
From: Olivier Coulaud <olivier.coulaud@inria.fr>
Date: Tue, 18 Feb 2025 14:10:25 +0100
Subject: [PATCH] Now the Readme.md is the first page of doxygen documentation
Fix typos in how to run check_2d
---
checks/check_2d.cpp | 4 +---
docs/Doxyfile.in | 2 +-
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/checks/check_2d.cpp b/checks/check_2d.cpp
index 7b5121dd6..32dc8023b 100644
--- a/checks/check_2d.cpp
+++ b/checks/check_2d.cpp
@@ -9,8 +9,6 @@
* @copyright Copyright (c) 2022
*
*/
-// make check_periodic
-// ./check/Release/check_2d --input-file check_per.fma -o 4 --tree-height 4 -gs 2
// @FUSE_FFTW
// @FUSE_CBLAS
#include <algorithm>
@@ -56,7 +54,7 @@
#include "scalfmm/utils/compare_trees.hpp"
/// \code {.c++}
-/// check/Release/check_2d - th 4 --order 5 --input - file../data/units/test_2d_ref.fma -gs 100 --check
+/// checks/Release/check_2d -th 4 --order 5 --input-file../data/units/test_2d_ref.fma -gs 100 --check
/// \endcode
///
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index b6a50e8e5..a81c3dfe0 100644
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -1079,7 +1079,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
-USE_MDFILE_AS_MAINPAGE = README.md
+USE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
--
GitLab