Will a JavaDoc and a little handwritten documentation be enough for a library? [closed]

softwareengineering.stackexchange https://softwareengineering.stackexchange.com/questions/384672

  •  18-02-2021
  •  | 
  •  

Question

I am wondering if I wrote a little simple documentation and provided the JavaDoc, would it be enough documentation for a application GUI manager library for java?

Was it helpful?

Solution

As GUI libraries / frameworks can follow a lot of different philosophies, I'd recommend some introductory texts, example code and visual results.

JavaDoc alone is only sufficient if the class model is self-explanatory, and I don't know any GUI framework where this is true.

Licensed under: CC-BY-SA with attribution
scroll top