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

Add Doxygen documentation #52

Merged
merged 6 commits into from
Jun 23, 2024
Merged

Add Doxygen documentation #52

merged 6 commits into from
Jun 23, 2024

Conversation

johnathanchann
Copy link
Contributor

@johnathanchann johnathanchann commented Jun 23, 2024

Before merging here are the few things required to setup

  1. Setting up Gh-pages branch
  • Go to your mcpp directory and create an empty branch named gh-pages and run the commands
git checkout --orphan gh-pages
git rm -rf .
git commit --allow-empty -m "init"
git push origin gh-pages```
  1. Setup github gh-pages on github settings
Settings > pages > Build and deployment > sources > select deploy from a branch
branch > select gh-pages >select /root dir
  1. Change your URL in readme.md
  • So for this version i have setup the link so that the dictionary page is the current temporary main page for v1.
  • Just replace INSERT_YOUR_URL with your url, please do not replace the html dir
  • Default URL would be https://YOUR_GITHUB_NAME.github.io/mcpp/

@johnathanchann
Copy link
Contributor Author

johnathanchann commented Jun 23, 2024

Please ignore the deploy-doxygen error, this is due to the repository is not merged and thus the gh-pages branch is inaccessible. It will work fine after merging

@rozukke rozukke changed the title Add/doxygen Add Doxygen documentation Jun 23, 2024
@rozukke rozukke added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 23, 2024
Copy link
Owner

@rozukke rozukke left a comment

Choose a reason for hiding this comment

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

Thank you for this sizeable contribution, which should hopefully be a step forward in the quality of the docs. I've included some changes that should be made before this can be merged.

.gitignore Outdated Show resolved Hide resolved
Doxyfile Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
include/mcpp/block.h Show resolved Hide resolved
include/mcpp/connection.h Show resolved Hide resolved
include/mcpp/mcpp.h Show resolved Hide resolved
include/mcpp/mcpp.h Outdated Show resolved Hide resolved
@johnathanchann
Copy link
Contributor Author

Resolved changes as per requested. Cheers

Copy link
Owner

@rozukke rozukke left a comment

Choose a reason for hiding this comment

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

Thanks for quick response, will merge and test now.

@rozukke rozukke merged commit 1a70cbc into rozukke:main Jun 23, 2024
2 of 3 checks passed
@johnathanchann johnathanchann deleted the add/doxygen branch June 23, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants