getappmap / getappmap/appmap-java
Enrich sequence diagram with JavaDoc comments
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 88
- Forks
- 17
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 1
Description
It would be useful to have more context for methods and call points in sequence diagrams. This would allow them to be demonstrated to analysts, customers and the product owner - people who do not have programming skills, but understand natural language.
In the past, I've made diagrams like this using my aspect-based instrumentation code and comment extractor from Java project sources.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how this Java agent produces sequence diagrams and how method or call-point context is represented. Compare the requested JavaDoc extraction with the linked extract-javadoc project and the author's aspect-based instrumentation approach; done means sequence diagrams expose useful natural-language method context for non-programmers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100