apache / apache/lucene

Include UML diagrams in javadocs [LUCENE-2296]

Open
#3,372 6 comments 0 reactions 0 assignees View on GitHub
affects-version:3.1 legacy-jira-fix-version:4.9 legacy-jira-fix-version:6.0 legacy-jira-priority:Major tool:build type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

As Lucene source becomes more and more complex it would be helpful to provide a visual overview of Lucene classes in a form of UML class diagrams. These can be created automatically during the build process, using ApiViz (http://code.google.com/p/apiviz/).

![package-summary.png](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-2296/package-summary.png)

---
Migrated from [LUCENE-2296](https://issues.apache.org/jira/browse/LUCENE-2296) by Andrzej Bialecki (@sigram), 2 votes, updated May 09 2016
Environment:
```
Any environment supported by AT&T GraphViz, e.g. Linux, MS Windows, etc.
```

Attachments: [apiviz.patch](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-2296/apiviz.patch), [package-summary.png](https://apache.github.io/lucene-jira-archive/attachments/LUCENE-2296/package-summary.png) (versions: 2)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the attached apiviz.patch and the build process that generates Lucene javadocs; the issue does not name current files or entry points. Check how ApiViz and AT&T GraphViz are expected to integrate, then verify that the build produces UML diagrams in the generated javadocs across a supported environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.