Is There a Way to Add the 'summary' tag?

[MGalatioto]

How can I add the summary tag? I did not find anyway with jax-rs or javadoc?

I guess it is not supported?

Thanks AGAIN in advance :-) 👍

[rmpestano]

Hi,

yes, just add a javadoc comment to the api method (also works for api parameters):

   /**
     * Deletes a car based on its ID
     *
     * @param user name of the user to log in
     * @param id car ID
     * @status 401 User not authorized
     * @status 403 User not authenticated
     */
    @DELETE
    @Path("/{id:[0-9][0-9]*}")
    @RestSecured
    public Response deleteById(@HeaderParam("user") String user, @PathParam("id") Integer id) {
        Car entity = carService.findById(id);
        if (entity == null) {
            return Response.status(Status.NOT_FOUND).build();
        }
        carService.remove(entity);
        return Response.noContent().build();
    }

[MGalatioto]

I did, but it does not work.. it appears in the description, but not as summary, which is also good though, but it would be nice if it would work.. :-)

THANKS for your quick answer!

[rmpestano]

Hi unfortunately only description is supported, see #107.

To achieve that we would need to introduce a new javadoc tag e.g @summary

[MGalatioto]

All right thanks! Status does not work either for me...? :)

[rmpestano]

In fact, it is @response but it will only work in next version, see this PR.

[MGalatioto]

All right! thank you!!