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

documentation: Provide KDoc to the Backend Packages #53

Open
Kareem100 opened this issue Jul 19, 2022 · 1 comment
Open

documentation: Provide KDoc to the Backend Packages #53

Kareem100 opened this issue Jul 19, 2022 · 1 comment
Assignees
@Kareem100
Labels
backend What links between the frontend and core documentation Improvements or additions to documentation

Comments

@Kareem100
Copy link
Member

Kareem100 commented Jul 19, 2022 •
edited
Loading

Provide KDoc i.e.(like JavaDoc) to the Whole Backend Packages.
Informing in detail what each block of code (function) and each file (class/interface) denotes.

Have to state the following tags:
description
@author
@SInCE [Optional]
@see
@Kareem100 Kareem100 added documentation Improvements or additions to documentation core structural or core changes backend What links between the frontend and core labels Jul 19, 2022
@Kareem100 Kareem100 changed the title doc: Provide KDoc to the Whole Packages documentation: Provide KDoc to the Whole Packages Jul 19, 2022
@Kareem100
Copy link
Member Author

Kareem100 commented Jul 19, 2022 •
edited
Loading

Currently working on it...

@Kareem100 Kareem100 self-assigned this Jul 19, 2022
@Kareem100 Kareem100 changed the title documentation: Provide KDoc to the Whole Packages documentation: Provide KDoc to the Backend Packages Jul 20, 2022
@Kareem100 Kareem100 removed the core structural or core changes label Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kareem100 Kareem100

Labels
backend What links between the frontend and core documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Kareem100