iiitl / iiitl/Stoxs

[docs]: Javadoc Documentation for Utility Classes

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation easy good first issue
Dominant language
TypeScript
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

## Description

- **Detailed Description:**
The `PortfolioInfo` class contains essential utility methods (e.g., calculating total portfolio value and distribution), but it lacks descriptive documentation. This can confuse new developers or students trying to understand the purpose and usage of these methods.
- **How to Solve:**
1. **Add Javadoc Comments:**
For each method in `PortfolioInfo`, add a Javadoc comment that describes its purpose, parameters, and return value. For example:
```java
/**
* Calculates the total portfolio value by summing the product of current price and quantity for each stock.
*
* @param stocks List of Stock objects
* @return The total portfolio value as a double
*/
public static double calculateTotalPortfolioValue(List stocks) { ... }
```
2. **Repeat for All Public Methods:**
Ensure that every public method in all utility classes is well documented.
3. **Generate Documentation:**
Optionally, generate the Javadoc HTML pages to verify that the documentation is clear.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the PortfolioInfo class and reviewing its public utility methods, then inspect the other utility classes named by the issue. Add Javadoc describing each public method’s purpose, parameters, and return value. Done means the public utility API is documented; optionally generate the Javadoc HTML pages to check the result.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.