Header banner
Revain logoHome Page
Chu Divett photo
Albuquerque
1 Level
77 Review
6 Karma

Review on MireDot by Chu Divett

Revainrating 5 out of 5

A nice little helper for documenting 3rd party libraries

It is easy to use, it generates well-structured code that's more readable than other tools I've used in similar situations - even though those are much older (like 10 years). The tool has some useful features like syntax highlighting or autoformatting of generated classes/methods etc., which helps me get started quickly with new APIs right away without having to dig through its manual first! There isn't any particular downside as far as we can see so far; however there might be something hidden from us yet :P We're generating Javadoc comments using this library internally at work now since our internal docs site was getting outdated fast due to frequent updates by external contributors who added their own methods & properties along them instead adding doc blocks directly into existing ones where appropriate.

Pros
  • Easy usage interface for beginners / learners while still offering advanced options
Cons
  • Minor Issues