Skip to content

doxyfile change #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,17 @@ jobs:
- name: Checkout code
uses: actions/checkout@v3

- name: Install Dependencies
run: |
sudo apt-get update
sudo apt-get install -y wget

- name: Install Doxygen
run: sudo apt-get install -y doxygen

- name: Create Output Directory
run: mkdir -p docs/doxygen

- name: Generate Documentation
run: doxygen Doxyfile

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙂‍↕️

Expand Down
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ cmake_install.cmake
Makefile

# Doxygen Output
docs/doxygen/

docs/
# Generated binaries and object files
*.obj
*.o
Expand All @@ -40,4 +39,3 @@ Thumbs.db

# Remove solution
cpp-ml/
docs/
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ option(BUILD_EXAMPLES "Build examples" ON)
include_directories(${CMAKE_CURRENT_SOURCE_DIR}/ml_library_include)

# Source files
# file(GLOB_RECURSE SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp") # Not using currently.
file(GLOB_RECURSE SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp")

# Define the library target
add_library(cpp_ml_library STATIC ${SOURCES})
Expand Down
10 changes: 5 additions & 5 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
#
# Note see also the list of default file extension mappings.

EXTENSION_MAPPING = md=markdown
EXTENSION_MAPPING = md=markdown

# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
Expand All @@ -358,7 +358,7 @@ EXTENSION_MAPPING = md=markdown
# case of backward compatibilities issues.
# The default value is: YES.

MARKDOWN_SUPPORT = YES
MARKDOWN_SUPPORT = YES

# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
Expand Down Expand Up @@ -402,7 +402,7 @@ BUILTIN_STL_SUPPORT = NO
# enable parsing support.
# The default value is: NO.

CPP_CLI_SUPPORT = NO
CPP_CLI_SUPPORT = YES

# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
Expand Down Expand Up @@ -635,7 +635,7 @@ INTERNAL_DOCS = NO
# Possible values are: SYSTEM, NO and YES.
# The default value is: SYSTEM.

CASE_SENSE_NAMES = SYSTEM
CASE_SENSE_NAMES = YES

# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
Expand Down Expand Up @@ -949,7 +949,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ./ml_library_include README.md ./tests ./examples
INPUT = ./src ./ml_library_include README.md ./tests ./examples

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
Empty file added src/association/Apriori.cpp
Empty file.
Empty file added src/association/Eclat.cpp
Empty file.
Empty file.
Empty file added src/clustering/KMeans.cpp
Empty file.
Empty file.
Empty file added src/clustering/KNNRegressor.cpp
Empty file.
Empty file added src/neural_network/ANN.cpp
Empty file.
Empty file added src/neural_network/CNN.cpp
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Loading