Skip to content

Fix doxygen compilation#20

Merged
nmellado merged 25 commits intomainfrom
fixDoxygen
Apr 7, 2024
Merged

Fix doxygen compilation#20
nmellado merged 25 commits intomainfrom
fixDoxygen

Conversation

@hiergaut
Copy link
Copy Markdown
Contributor

@hiergaut hiergaut commented Mar 22, 2024 •
edited
Loading

All public function, member of class have to be commented (checked by doxygen).
Only fix doxygen compilation for the project.
Another PR will make the full documentation.
Deploy doxygen doc to github page.

@hiergaut hiergaut requested a review from nmellado March 22, 2024 13:47
hiergaut
hiergaut commented Mar 22, 2024
View reviewed changes
@hiergaut hiergaut mentioned this pull request Mar 22, 2024
Merged
@hiergaut hiergaut force-pushed the fixDoxygen branch 2 times, most recently from b2cf6b4 to 005459a Compare March 25, 2024 16:09
@hiergaut
Copy link
Copy Markdown
Contributor Author

hiergaut commented Mar 25, 2024

@nmellado ready to merge

@nmellado
Copy link
Copy Markdown
Contributor

nmellado commented Mar 25, 2024

The added make doxygen happy, but do not add any meaningful content.
Also, I still see methods without comments in the files.

@hiergaut
Copy link
Copy Markdown
Contributor Author

hiergaut commented Mar 25, 2024

I am going to do a full doxygen revision next days ...

@hiergaut hiergaut marked this pull request as draft March 26, 2024 13:09
@hiergaut
Copy link
Copy Markdown
Contributor Author

hiergaut commented Mar 28, 2024

waiting for #22 merged

@hiergaut hiergaut marked this pull request as ready for review April 4, 2024 09:43
@hiergaut hiergaut changed the title Fix doxygen Fix doxygen compilation Apr 4, 2024
@hiergaut
Copy link
Copy Markdown
Contributor Author

hiergaut commented Apr 4, 2024 •
edited
Loading

I have some stuff to do (in code), coming soon.

@hiergaut
Copy link
Copy Markdown
Contributor Author

hiergaut commented Apr 4, 2024 

/usr/bin/git push origin gh-pages
remote: Permission to T-PLAY/hub.git denied to github-actions[bot].
fatal: unable to access 'https://github.com/T-PLAY/hub.git/': The requested URL returned error: 403
Error: Action failed with "The process '/usr/bin/git' failed with exit code 128"

Unable to push to git page, can you specify me, what is the github page url please ?

@hiergaut
Copy link
Copy Markdown
Contributor Author

hiergaut commented Apr 5, 2024

Ok thanks for the help.
I did some code refactor to fix doxygen because of some weird stuff like bad includes etc.
I moved any stl implement (C++11, C++14) to external folder because I didn't want to document this code.
@nmellado ready for review

@hiergaut hiergaut added documentation Improvements or additions to documentation refactoring Refactoring code may break everything labels Apr 5, 2024
@nmellado
Copy link
Copy Markdown
Contributor

nmellado commented Apr 5, 2024

The action do not find the doc files
https://github.com/T-PLAY/hub/actions/runs/8567529175/job/23479489255?pr=20#step:6:873
can you have a look ?

@hiergaut
Copy link
Copy Markdown
Contributor Author

hiergaut commented Apr 5, 2024

@nmellado ready to merge for me

@nmellado nmellado merged commit b3f7157 into main Apr 7, 2024
@nmellado nmellado deleted the fixDoxygen branch April 7, 2024 22:15
@hiergaut hiergaut mentioned this pull request Apr 22, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nmellado nmellado Awaiting requested review from nmellado

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation refactoring Refactoring code may break everything

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hiergaut @nmellado