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

Documentation pipeline update #5

Closed
wants to merge 48 commits into from

Conversation

reubenlindroos
Copy link
Collaborator

@reubenlindroos reubenlindroos commented Apr 29, 2021

Pipeline to automatically create documenation on read the docs using doxygen.

  • link to github page on index.html (mainpage.hpp)
  • add documentation convention to docs\README.md
  • fork branch from cr333/main and apply changes to that
  • create new PR from forked branch

@cr333 cr333 marked this pull request as draft May 10, 2021 16:47
Copy link
Owner

@cr333 cr333 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 this, @reubenlindroos!

Apologies for the many comments. I hope they are not too hard to address.

One thing is unclear to me: why does this PR delete the demo images? Maybe it would help to rebase your branch on cr333/OmniPhotos or copy your changes over in a new branch?

docs/README.md Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated

}
The `@brief` notation is not strictly necessary, only important for clarity.
Copy link
Owner

Choose a reason for hiding this comment

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

Is it important for clarity?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

clarity -> explicit

src/Core/Geometry/PointCloud.hpp Outdated Show resolved Hide resolved
src/Core/Geometry/Sphere.hpp Outdated Show resolved Hide resolved
src/Core/GUI/VRInterface.hpp Outdated Show resolved Hide resolved
src/Core/Geometry/Circle.hpp Outdated Show resolved Hide resolved
src/Core/Geometry/Circle.hpp Outdated Show resolved Hide resolved
src/Core/Geometry/Circle.hpp Outdated Show resolved Hide resolved
src/Core/Geometry/Cylinder.hpp Outdated Show resolved Hide resolved
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
@reubenlindroos
Copy link
Collaborator Author

One thing is unclear to me: why does this PR delete the demo images? Maybe it would help to rebase your branch on cr333/OmniPhotos or copy your changes over in a new branch?

@cr333 I think the reason its deleting the images is because of the previous merge with the PR #7 . I'll have to be careful when merging.

reubenlindroos and others added 19 commits June 3, 2021 11:55
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
Co-authored-by: Christian Richardt <christian@richardt.name>
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.

None yet

2 participants