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

Update generated JavaDoc documentation #65

Merged
merged 3 commits into from
Aug 16, 2023
Merged

Update generated JavaDoc documentation #65

merged 3 commits into from
Aug 16, 2023

Conversation

aricasas
Copy link
Contributor

This PR fixes a couple mistakes in our JavaDoc and updates the generated JavaDoc website to contain our new factory classes and to contain our new class names.

@aricasas aricasas added the documentation Improvements or additions to documentation label Aug 16, 2023
@aricasas aricasas self-assigned this Aug 16, 2023
@aricasas aricasas linked an issue Aug 16, 2023 that may be closed by this pull request
Update generated JavaDoc documentation #63
Closed
katarinaavucic
katarinaavucic approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@katarinaavucic katarinaavucic left a comment

Choose a reason for hiding this comment

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

Yay!!!!!

YinLingithub
YinLingithub reviewed Aug 16, 2023
View reviewed changes
Copy link
Contributor

@YinLingithub YinLingithub left a comment

Choose a reason for hiding this comment

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

Is there a reason why the Javadoc/report is much less than before? (you've deleted 17914 and added 10427)

luluwuwu
luluwuwu approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@luluwuwu luluwuwu left a comment

Choose a reason for hiding this comment

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

Good

@aricasas
Copy link
Contributor Author

I think it's because a lot of the files are being just modified instead of deleted

@YinLingithub
Copy link
Contributor

I think it's because a lot of the files are being just modified instead of deleted

But I would imagine the number of lines added will be more than number of lines deleted right? As we have many more classes in the entities package.

@aricasas
Copy link
Contributor Author

Tbh I don't really know, I checked and all of our classes are there with their new names, including the factory classes. Maybe it's just that the HTML got generated differently or something

@YinLingithub
Copy link
Contributor

Tbh I don't really know, I checked and all of our classes are there with their new names, including the factory classes. Maybe it's just that the HTML got generated differently or something

I briefly took a look through all the files, and found that there were some files for the tests but they are deleted. Maybe it's those files?

YinLingithub
YinLingithub approved these changes Aug 16, 2023
View reviewed changes
Copy link
Contributor

@YinLingithub YinLingithub left a comment

Choose a reason for hiding this comment

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

Looks good!

@aricasas aricasas merged commit a5500d6 into main Aug 16, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@katarinaavucic katarinaavucic katarinaavucic approved these changes

@luluwuwu luluwuwu luluwuwu approved these changes

@YinLingithub YinLingithub YinLingithub approved these changes

Assignees

@aricasas aricasas

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update generated JavaDoc documentation
4 participants
@aricasas @YinLingithub @katarinaavucic @luluwuwu