Skip to content

Commit 66d484e

Browse files
committed
Add doxygen
1 parent fefb259 commit 66d484e

1 file changed

Lines changed: 9 additions & 45 deletions

File tree

DOXYGEN

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8
4242
# title of most generated pages and in a few other places.
4343
# The default value is: My Project.
4444

45-
PROJECT_NAME = "My Project"
45+
PROJECT_NAME = "SLB4MPI"
4646

4747
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
4848
# could be handy for archiving the generated documentation or if some version
@@ -54,7 +54,7 @@ PROJECT_NUMBER =
5454
# for a project that appears at the top of each page and should give viewers a
5555
# quick idea about the purpose of the project. Keep the description short.
5656

57-
PROJECT_BRIEF =
57+
PROJECT_BRIEF = "Simple load balancers for MPI"
5858

5959
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
6060
# in the documentation. The maximum height of the logo should not exceed 55
@@ -74,7 +74,7 @@ PROJECT_ICON =
7474
# entered, it will be relative to the location where Doxygen was started. If
7575
# left blank the current directory will be used.
7676

77-
OUTPUT_DIRECTORY =
77+
OUTPUT_DIRECTORY = docs/
7878

7979
# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
8080
# sub-directories (in 2 levels) under the output directory of each output format
@@ -312,7 +312,7 @@ OPTIMIZE_OUTPUT_JAVA = NO
312312
# sources. Doxygen will then generate output that is tailored for Fortran.
313313
# The default value is: NO.
314314

315-
OPTIMIZE_FOR_FORTRAN = NO
315+
OPTIMIZE_FOR_FORTRAN = YES
316316

317317
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
318318
# sources. Doxygen will then generate output that is tailored for VHDL.
@@ -1032,61 +1032,25 @@ INPUT_FILE_ENCODING =
10321032
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
10331033

10341034
FILE_PATTERNS = *.c \
1035-
*.cc \
10361035
*.cxx \
1037-
*.cxxm \
10381036
*.cpp \
1039-
*.cppm \
1040-
*.ccm \
1041-
*.c++ \
1042-
*.c++m \
1043-
*.java \
1044-
*.ii \
1045-
*.ixx \
1046-
*.ipp \
1047-
*.i++ \
1048-
*.inl \
1049-
*.idl \
1050-
*.ddl \
1051-
*.odl \
10521037
*.h \
1053-
*.hh \
10541038
*.hxx \
10551039
*.hpp \
1056-
*.h++ \
1057-
*.l \
1058-
*.cs \
1059-
*.d \
1060-
*.php \
1061-
*.php4 \
1062-
*.php5 \
1063-
*.phtml \
1064-
*.inc \
1065-
*.m \
1066-
*.markdown \
10671040
*.md \
1068-
*.mm \
1069-
*.dox \
1070-
*.py \
1071-
*.pyw \
10721041
*.f90 \
10731042
*.f95 \
10741043
*.f03 \
10751044
*.f08 \
10761045
*.f18 \
10771046
*.f \
1078-
*.for \
1079-
*.vhd \
1080-
*.vhdl \
1081-
*.ucf \
1082-
*.qsf \
1083-
*.ice
1047+
*.for
10841048

10851049
# The RECURSIVE tag can be used to specify whether or not subdirectories should
10861050
# be searched for input files as well.
10871051
# The default value is: NO.
10881052

1089-
RECURSIVE = NO
1053+
RECURSIVE = YES
10901054

10911055
# The EXCLUDE tag can be used to specify files and/or directories that should be
10921056
# excluded from the INPUT source files. This way you can easily exclude a
@@ -1125,21 +1089,21 @@ EXCLUDE_SYMBOLS =
11251089
# that contain example code fragments that are included (see the \include
11261090
# command).
11271091

1128-
EXAMPLE_PATH =
1092+
EXAMPLE_PATH = examples/
11291093

11301094
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
11311095
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
11321096
# *.h) to filter out the source-files in the directories. If left blank all
11331097
# files are included.
11341098

1135-
EXAMPLE_PATTERNS = *
1099+
EXAMPLE_PATTERNS = examples/*
11361100

11371101
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
11381102
# searched for input files to be used with the \include or \dontinclude commands
11391103
# irrespective of the value of the RECURSIVE tag.
11401104
# The default value is: NO.
11411105

1142-
EXAMPLE_RECURSIVE = NO
1106+
EXAMPLE_RECURSIVE = YES
11431107

11441108
# The IMAGE_PATH tag can be used to specify one or more files or directories
11451109
# that contain images that are to be included in the documentation (see the

0 commit comments

Comments
 (0)