When comparing dox vs apiDoc, the Slant community recommends apiDoc for most people. In the question“What are the best documentation generators for Node.js apps?” apiDoc is ranked 3rd while dox is ranked 4th. The most important reason people chose apiDoc is:
Adds ability to test out your endpoints from the documentation
Ranked in these QuestionsQuestion Ranking
Pros
Pro Supports all jsDoc tags
dox has built-in support for all jsDoc tags and allows you to specify complex object types including optional flag =
, nullable ?
, non-nullable !
and variable arguments ...
Pro Built in REST client
Adds ability to test out your endpoints from the documentation
Pro Multi language support
Supports documenting other languages (other than just JS)
Cons
Con Needs to be integrated with another tool to generate readable documentation
dox only generates a JSON representation of the documentation. In order to have a fully readable documentation you need to integrate it with some other library that parses the JSON and returns HTML or markdown.
Con Only really useful for RESTful web APIs
Can't be used for documenting the application in general