Add anchor tag in javadoc to reference documents.
junghoon-vans opened this issue · comments
Description
Add an anchor to link the URL that exists in the javadoc to the reference documentation.
Basic example
AS-IS
/**
* Class covering the Meilisearch Task API
*
* <p>https://www.meilisearch.com/docs/reference/api/tasks
*/
public class TasksHandler { ... }Currently, it's inconvenient for users to access reference documentation through javadoc.
TO-BE
/**
* Class covering the <a href="https://www.meilisearch.com/docs/reference/api/tasks">Meilisearch Task API</a>.
*/
public class TasksHandler { ... }Users can access reference documentation with just a click.
Other
Hello @junghoon-vans
thanks for the suggestion
PRs are welcome for this 😊
We will be available for review
Yes you can take care of it, since the #666 PR is currently in a pending state (missing test fixes)
@curquiza As I was working on this, I realized that using the @see tag was a good idea.
For example:
/**
* Data structure of the query parameters of the documents route when retrieving a document
*
* @see <a href="https://www.meilisearch.com/docs/reference/api/documents#query-parameters-1">API
* specification</a>
*/
@Setter
@Getter
public class DocumentQuery { ... }
Note that this approach is also used in Elasticsearch-java.
Let's go with this then, I rely on you for this!