File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

How to document the User Interface.

Mihai Radulescu
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

I have problem, or at least I think I have - I don't knoiw how/what to document it.
On the first line I explain how the class works and for what was desinged -also with exapmles, but I also I describe the GUI, how its look and how it renders the information. By example :
"The view uses to render the database file path a text field .....".

Is this right or I go a little bit to far with ui documetation.

[ January 24, 2006: Message edited by: Mihai Radulescu ]
I agree. Here's the link:
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic