frankframework / frankframework/frank-doc
Not all elements that need it have @inheritdoc
- Dominant language
- Java
- Stars
- 5
- Forks
- 5
- Avg merge
- 1h 20m
- Merged PRs (30d)
- 1
Description
Issue #329 was created because forwards seemed to be missing, but they weren't put on the element because `@inheritdoc` wasn't set. The current solution has the frontend looking for forwards on the parent classes but this should not be the final solution. Element notes suffer from the same issue.
It is expected notes & forwards are flattened onto the elements that have them without the frontend having to look for them on the parents.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by tracing how @inheritdoc is handled, how forwards and element notes are found on parent classes, and where the frontend consumes them. Done means notes and forwards are flattened onto the elements that own them, without frontend lookup on parent classes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100