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.

Sign up for GitHub

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

Jump to bottom

add documentation #63

Open
mgerhold opened this issue Apr 10, 2023 · 3 comments · May be fixed by #66
Open

add documentation #63

mgerhold opened this issue Apr 10, 2023 · 3 comments · May be fixed by #66
Assignees
@mgerhold

Comments

@mgerhold
Copy link
Contributor

No description provided.

@mgerhold mgerhold converted this from a draft issue Apr 10, 2023
@mgerhold mgerhold moved this from Todo to In Progress in OOPetris Apr 10, 2023
@mgerhold mgerhold linked a pull request Apr 10, 2023 that will close this issue
Draft
@mgerhold mgerhold linked a pull request Apr 10, 2023 that will close this issue
63 add documentation #66
Draft
@mgerhold mgerhold self-assigned this Apr 13, 2023
@Totto16
Copy link
Collaborator

Totto16 commented Apr 13, 2023

I just wanted to ask which documentation "software" / utility / format is used here, so that i can use the same in #24

@mgerhold
Copy link
Contributor Author

I'd go for Doxygen and I already started adding Doxygen comments in a branch (see here for example).
It would be great if the CI would automatically generate the HTML documentation and upload it so that it is visible on a "GitHub Pages" page (like I also did in this project, but there I was using Travis-CI instead of GitHub actions).

@Totto16
Copy link
Collaborator

Totto16 commented Apr 15, 2023

Thats surely possible also without travis CI 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mgerhold mgerhold

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

63 add documentation OpenBrickProtocolFoundation/oopetris
2 participants
@Totto16 @mgerhold