• Post Reply Bookmark Topic Watch Topic
  • New Topic

terseness of javadoc for gui/swing code

 
Raj Nagappan
Ranch Hand
Posts: 38
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I'm writing up my javadoc at the moment and I notice that most of my doc for the GUI stuff is very brief. I put this down to the code being mostly unremarkable form builder stuff and registering of event listeners, etc.

Is this terseness ok or am I just being too lazy? It seems straightforward to me what a gui form does in contrast to a non-gui method that provides some sort service to client code.

Did the other candidates who got full marks for documentation provide detailed or terse javadoc for their gui code?

Raj.
 
my overalls have superpowers - they repel people who think fashion is important. Tiny ad:
the new thread boost feature brings a LOT of attention to your favorite threads
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!