Enrich sequence diagram with JavaDoc comments

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
tooling

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.

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.

Dominant language
Java
Stars
88
Forks
17
Avg merge
2d 2h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

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.

More from getappmap/appmap-java

All issues in getappmap/appmap-java

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.