INRIA / INRIA/spoon

Parse Javadoc contents and inline tags ({@link})

Open
#3,814 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
2k
Forks
392
Avg merge
11h 24m
Merged PRs (30d)
36

Description

## Preface - Usage Scenario
I am currently trying to write a less crappy version of a javadoc bot:

The current iteration parses the online HTML javadoc on-the-fly, extracts relevant fields (`throws`, `@param` tags, etc.) and then converts the whole thing to markdown.

## What I wanted to do with Spoon
I would like to generate a database containing all necessary information to generate the messages using spoon. This would allow me to implement a better search functionality and not be reliant on the HTML layout of the generated pages.

## My problem
Currently spoon seems to only superficially parse javadoc comments: It allows you to get the tags (`@param`, etc.) and the short/long description but there doesn't seem to be a way to properly parse and attribute inline tags like `{@link}`. Sadly I need to do just that, as I want to embed links to the proper javadoc pages in the message which require the fully qualified name of the class and method.

@MartinWitt suggested I should open an issue for this.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.