Atlassian REST API Browser dosn't show Java Doc Comments


I’m trying to document my own REST resources with the Atlassian REST API Browser. They do show up, but my Javadoc descriptions aren’t included.

According to this document adding the Javadoc comments should be enough:

this is my resource:

     * ping method to test connection
     * @param ping object containing connection info {@link Ping}
     * @return {@link Response}
     * @author Caroline
    @Consumes({ MediaType.APPLICATION_JSON })
    @Produces({ MediaType.APPLICATION_JSON })
    public Response ping(Ping ping) {
        return response;

and it looks like this in the RAB:

Is the documentation deprecated or am I missing something?

1 Like