Skip to content
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

[ISSUE-207] Doxygen document #743

Open
wants to merge 2 commits into
base: SharedDevelopment
Choose a base branch
from
Open
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
10 changes: 0 additions & 10 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -405,16 +405,6 @@ target_link_libraries(serialFirstHalfTest combinedLib)
target_link_libraries(serialSecondHalfTest stdc++fs)
target_link_libraries(serialSecondHalfTest combinedLib)

add_executable(serialFileAccessTest
Testing/RunTests.cpp
Testing/UnitTesting/SerializationFileAccessTest.cpp)

# Links the Googletest framework with the serialFileAccessTest executable
target_link_libraries(serialFileAccessTest gtest gtest_main)

# Link the combined library into the 'serialFileAccessTest' executable.
target_link_libraries(serialFileAccessTest combinedLib)

# Clear ENABLE_CUDA, PERFORMANCE_METRICS and GPROF from the cache so it's reset for subsequent builds
unset(ENABLE_CUDA CACHE)
unset(PERFORMANCE_METRICS CACHE)
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -864,7 +864,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = Simulator/
INPUT = Simulator/ docs/Doxygen/index.md

# 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
19 changes: 19 additions & 0 deletions docs/Doxygen/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Graphitti Doxygen Documentation

Welcome to the Graphitti Doxygen documentation!

This documentation provides an overview of the Graphitti project's codebase and related resources. It includes detailed information about classes, functions, and structures.

## Documentation Sections

- [Classes](classes.md): Explore the detailed code reference documentation for Graphitti's classes, structs, unions and interfaces.
- [Files](files.md): Here is the documentation for Graphitti's documented files with descriptions and documentation.

Feel free to navigate through the documentation using the top navigation bar. If you have any questions or need further assistance, please refer to the project's official repository or documentation.

## Additional Resources

- [Graphitti GitHub Repository](https://github.com/UWB-Biocomputing/Graphitti): Explore the source code, report issues, and contribute to the project.
- [Graphitti Project Website](https://uwb-biocomputing.github.io/Graphitti/): Visit the official website for more information about the Graphitti project.

We hope you find this documentation useful and informative. Happy coding!
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@

2.8 [Serialization](Developer/Serialization.md)

4. [Testing](Testing/index.md)
3. [Testing](Testing/index.md)

3.1 Array Performance Testing
3.1 [Array Performance Testing](Testing/ArrayPerformance/ArrayPerformance.md)

3.2 Dynamic Cast Performance Testing
3.2 [Dynamic Cast Performance Testing](Testing/CastingTest/CastingTest.md)

3.3 Test Config Files
3.3 [Test Config Files](Testing/TestConfigFileParameters/testConfigFileParameters.md)

5. Notes
4. Notes

4.1 [General Notes](RebuildNotes/GeneralNotes.md)

Expand All @@ -54,7 +54,7 @@

4.6 [Recorder Notes](RebuildNotes/RecordersNotes.md)

6. [Glossary](Glossary.md)
5. [Glossary](Glossary.md)

5.1 Graph Vocabulary

Expand Down
Loading