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

Development: Add JavaDocs to UtilServices and Factories [8] #7374

Merged
merged 10 commits into from
Oct 29, 2023
Merged

Development: Add JavaDocs to UtilServices and Factories [8] #7374

merged 10 commits into from
Oct 29, 2023

Conversation

laadvo
Copy link
Contributor

@laadvo laadvo commented Oct 14, 2023 •
edited
Loading

Checklist

General

Server

Motivation and Context

Improve the readability of UtilServices and Factories by adding JavaDoc to helper methods.

Description

Added JavaDoc to following files:

  • exercise/quizexercise/QuizExerciseFactory.java
  • exercise/quizexercise/QuizExerciseUtilService.java

also moved some helper methods from QuizExerciseUtilService to QuizExerciseFactory.

Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Test Coverage

unchanged

@github-actions github-actions bot added the tests label Oct 14, 2023
@DominikRemo DominikRemo mentioned this pull request Oct 18, 2023
Merged
42 tasks
@laadvo laadvo marked this pull request as ready for review October 18, 2023 15:49
@laadvo laadvo requested a review from a team as a code owner October 18, 2023 15:49
DominikRemo
DominikRemo previously approved these changes Oct 20, 2023
View reviewed changes
Copy link
Contributor

@DominikRemo DominikRemo left a comment

Choose a reason for hiding this comment

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

LGTM, just two optional nitpicks

src/test/java/de/tum/in/www1/artemis/exercise/quizexercise/QuizExerciseFactory.java Outdated Show resolved Hide resolved
src/test/java/de/tum/in/www1/artemis/exercise/quizexercise/QuizExerciseFactory.java Outdated Show resolved Hide resolved
egekurt123
egekurt123 previously approved these changes Oct 24, 2023
View reviewed changes
Copy link
Contributor

@egekurt123 egekurt123 left a comment

Choose a reason for hiding this comment

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

Documentation text looks decent.

laadvo and others added 3 commits October 25, 2023 19:28
@laadvo
Merge branch 'develop' into development/add-javadoc-to-utilservices-a…
bac09e4 
…nd-factories/add-javadoc-group-8
@laadvo
implement Dominik's suggestions 2
71f53c0
@laadvo
Merge remote-tracking branch 'origin/development/add-javadoc-to-utils…
37d2eef 
…ervices-and-factories/add-javadoc-group-8' into development/add-javadoc-to-utilservices-and-factories/add-javadoc-group-8
@laadvo laadvo changed the base branch from develop to development/add-javadoc-to-utilservices-and-factories/main October 29, 2023 13:16
@laadvo
Merge branch 'development/add-javadoc-to-utilservices-and-factories/m…
aca4314 
…ain' into development/add-javadoc-to-utilservices-and-factories/add-javadoc-group-8
@github-actions github-actions bot added server Pull requests that update Java code. (Added Automatically!) client Pull requests that update TypeScript code. (Added Automatically!) documentation config-change Pull requests that change the config in a way that they require a deployment via Ansible. template labels Oct 29, 2023
@laadvo laadvo removed server Pull requests that update Java code. (Added Automatically!) client Pull requests that update TypeScript code. (Added Automatically!) documentation config-change Pull requests that change the config in a way that they require a deployment via Ansible. labels Oct 29, 2023
@laadvo
Merge branch 'development/add-javadoc-to-utilservices-and-factories/m…
b7b2f7d 
…ain' into development/add-javadoc-to-utilservices-and-factories/add-javadoc-group-8
@github-actions github-actions bot removed the template label Oct 29, 2023
@laadvo laadvo merged commit 85eaf66 into development/add-javadoc-to-utilservices-and-factories/main Oct 29, 2023
16 of 18 checks passed
@laadvo laadvo deleted the development/add-javadoc-to-utilservices-and-factories/add-javadoc-group-8 branch October 29, 2023 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@egekurt123 egekurt123 egekurt123 approved these changes

@DominikRemo DominikRemo DominikRemo approved these changes

@MaximilianAnzinger MaximilianAnzinger Awaiting requested review from MaximilianAnzinger

Assignees

@laadvo laadvo

Labels
ready to merge tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@laadvo @MaximilianAnzinger @DominikRemo @egekurt123