Używanie adnotacji JSONDoc dla metod zwracających ModelAndView

0

Używam w projekcie biblioteki JSODoc do robienia dokumentacji. Już zrobiłem dokumentację dla wszystkich klas @RestController i ich metod, czyli dla całego REST API. Jednakże w projekcie mam również kilka klas @Controller, które zwracają ModelAndView. Więcz czy dla takich metod i kontrolerów również można używać adnotacji na przykład @Api lub @ApiMethod?

@RequestMapping(method = RequestMethod.GET)
@ApiMethod(description = "Returns a ModelAndView for the login form")
public ModelAndView signIn() {
    return new ModelAndView("signIn");
}

Można tak udokumentować metodę zwracającą ModelAndView czy muszą to być tylko response obiekty?

0

A po co chciałbyś te metody w ogóle dokumentować w ten sposób? Przecież nikt nie powinien w ogóle o nic wiedzieć na dobrą sprawę.

1 użytkowników online, w tym zalogowanych: 0, gości: 1