Skip to content

Commit 09060f7

Browse files
committed
Fix documentation
1 parent 42cc45a commit 09060f7

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

Doxyfile

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ PROJECT_NUMBER = 0.3.0
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 = "C++ Implementation of the Scottish COVID Response Consortium FAIR Data Pipeline"
47+
PROJECT_BRIEF = "C++ Implementation of the FAIR Data Pipeline API"
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
@@ -874,7 +874,9 @@ WARN_LOGFILE =
874874
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
875875
# Note: If this tag is empty the current directory is searched.
876876

877-
INPUT =
877+
INPUT = src \
878+
include \
879+
README.md
878880

879881
# This tag can be used to specify the character encoding of the source files
880882
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -954,7 +956,7 @@ FILE_PATTERNS = *.c \
954956
# be searched for input files as well.
955957
# The default value is: NO.
956958

957-
RECURSIVE = NO
959+
RECURSIVE = YES
958960

959961
# The EXCLUDE tag can be used to specify files and/or directories that should be
960962
# excluded from the INPUT source files. This way you can easily exclude a
@@ -1072,7 +1074,7 @@ FILTER_SOURCE_PATTERNS =
10721074
# (index.html). This can be useful if you have a project on for instance GitHub
10731075
# and want to reuse the introduction page also for the doxygen output.
10741076

1075-
USE_MDFILE_AS_MAINPAGE =
1077+
USE_MDFILE_AS_MAINPAGE = README.md
10761078

10771079
#---------------------------------------------------------------------------
10781080
# Configuration options related to source browsing

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
html/
2+
latex/

include/fdp/fdp.hxx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#include "fdp/registry/datapipeline.hxx"
22

33
namespace FDP {
4+
/**
5+
* @brief DataPipeline Class:
6+
* A PIMPL Class for interacting the the FAIR Data Pipeline
7+
*
8+
*/
49
class DataPipeline {
510
public:
611
/**

0 commit comments

Comments
 (0)