Skip to content

Resolved Issue #18 - #48

Merged
camaechi merged 4 commits into
masterfrom
#18
Jul 22, 2023
Merged

Resolved Issue #18#48
camaechi merged 4 commits into
masterfrom
#18

Conversation

@camaechi

@camaechi camaechi commented Jul 21, 2023

Copy link
Copy Markdown

Doxygen documentation has been implemented in this pull request. To ensure consistency, all existing comment syntax has been reformatted to use the "///" syntax, which is the standard syntax for comments to appear in Doxygen documentation.

To open up the Doxygen documentation, please follow these instructions:

  1. Locate the Doxygen-Doc folder.
  2. Open the Doxygen-Doc folder by double-clicking on it.
  3. Inside the Doxygen-Doc folder, you will find an "html" folder. Open it.
  4. Look for a file named "index" within the "html" folder.
  5. Double-click on the "index" file to open it.
  6. The Doxygen documentation should now be displayed in your default web browser.

Please inform me if you have any questions or if any modifications need to be made.

@camaechi
camaechi requested review from TonePoems and dburd08 July 21, 2023 00:00
@camaechi camaechi self-assigned this Jul 21, 2023
@camaechi camaechi linked an issue Jul 21, 2023 that may be closed by this pull request
@camaechi

Copy link
Copy Markdown
Author

To open up the Doxygen documentation, please follow these instructions:

  1. Locate the Doxygen-Doc folder.
  2. Open the Doxygen-Doc folder by double-clicking on it.
  3. Inside the Doxygen-Doc folder, you will find an "html" folder. Open it.
  4. Look for a file named "index" within the "html" folder.
  5. Double-click on the "index" file to open it.
  6. The Doxygen documentation should now be displayed in your default web browser.

@TonePoems TonePoems left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Documentation will suffer as a result of lack of general comments and function level comments, but that issue is from the original project and the functionality is all here. Looks good!

@dburd08 dburd08 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good job getting the documentation set up

@camaechi
camaechi merged commit e62b401 into master Jul 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Auto Documentation

3 participants