Skip to content

Commit

Permalink
adding READM as main page of Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
mgonzs13 committed Nov 3, 2024
1 parent 466fc14 commit 862394e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
8 changes: 5 additions & 3 deletions .github/Doxyfile-cpp
Original file line number Diff line number Diff line change
Expand Up @@ -949,7 +949,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = yasmin \
INPUT = README.md \
yasmin \
yasmin_ros \
yasmin_viewer \
yasmin_demos
Expand Down Expand Up @@ -992,7 +993,8 @@ INPUT_FILE_ENCODING =
# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.

FILE_PATTERNS = *.c \
FILE_PATTERNS = *.md \
*.c \
*.cpp \
*.hpp

Expand Down Expand Up @@ -1122,7 +1124,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 =
USE_MDFILE_AS_MAINPAGE = README.md

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down
8 changes: 5 additions & 3 deletions .github/Doxyfile-python
Original file line number Diff line number Diff line change
Expand Up @@ -949,7 +949,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = yasmin \
INPUT = README.md \
yasmin \
yasmin_ros \
yasmin_viewer \
yasmin_demos
Expand Down Expand Up @@ -992,7 +993,8 @@ INPUT_FILE_ENCODING =
# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.

FILE_PATTERNS = *.py
FILE_PATTERNS = *.md \
*.py

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
Expand Down Expand Up @@ -1120,7 +1122,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 =
USE_MDFILE_AS_MAINPAGE = README.md

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down

0 comments on commit 862394e

Please sign in to comment.