Doxygen document by silvercube227 PR #545

Author: Divya Kamath

docs/Doxygen/Doxyfile

@@ -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

docs/Doxygen/index.md

@@ -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!

docs/index.md

@@ -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)
 
@@ -54,7 +54,7 @@
 
    4.6 [Recorder Notes](RebuildNotes/RecordersNotes.md)
 
-6. [Glossary](Glossary.md)
+5. [Glossary](Glossary.md)
 
    5.1 Graph Vocabulary