Skip to content

Commit 331a521

Browse files
Remove JAVADOC.md and revert CONTRIBUTING.md changes per review feedback
Co-authored-by: thomasturrell <1552612+thomasturrell@users.noreply.github.com>
1 parent 01a8375 commit 331a521

2 files changed

Lines changed: 1 addition & 293 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -228,38 +228,7 @@ void testStatementSerialization() throws JsonProcessingException {
228228

229229
### Documentation
230230

231-
#### JavaDoc Guidelines
232-
233-
All public APIs must be documented with comprehensive JavaDoc comments:
234-
235-
- **Classes and interfaces**: Include a brief description and link to relevant xAPI specification sections
236-
- **Public methods**: Document purpose, parameters (`@param`), return values (`@return`), and exceptions (`@throws`)
237-
- **Validation annotations**: Include `@return` tags for `message()`, `groups()`, and `payload()` methods
238-
- **Constructor parameters**: Document all constructor parameters with `@param` tags
239-
240-
**Important**: Lombok-generated code (builders, constructors) may produce unavoidable javadoc warnings. These are suppressed via Maven configuration and do not need manual documentation.
241-
242-
Example:
243-
```java
244-
/**
245-
* Gets a Statement from the LRS.
246-
* <p>
247-
* The returned ResponseEntity contains the response headers and the Statement.
248-
* </p>
249-
*
250-
* @param request the get statement request
251-
*
252-
* @return the ResponseEntity containing the statement
253-
*
254-
* @see <a href="https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Communication.md#213-get-statements">xAPI GET Statements</a>
255-
*/
256-
public Mono<ResponseEntity<Statement>> getStatement(GetStatementRequest request) {
257-
// implementation
258-
}
259-
```
260-
261-
**Generating JavaDoc**: Run `./mvnw javadoc:javadoc` to verify documentation quality.
262-
231+
- **JavaDoc**: Document all public APIs with comprehensive JavaDoc comments
263232
- **README**: Update if your changes affect usage examples or getting started instructions
264233
- **Code Comments**: Add comments only when necessary to explain complex logic (match existing style)
265234
- Maintain copyright headers in all source files: `Copyright 2016-2025 Berry Cloud Ltd. All rights reserved.`

JAVADOC.md

Lines changed: 0 additions & 261 deletions
This file was deleted.

0 commit comments

Comments
 (0)