Here's a link to Sun's Javadoc pages. it has a FAQ and other trails. JavaDoc main page
As far as the <code> tag, if you are talking about in this forum. It is so that your formatted code is shown in that format. If you just past it in a reply then you probably won't get your nice Tabs in there, and things won't line up and look nice a pretty. Mark
Nilesh Adam is talking about the comments in the Data.java file. They are the comments above each method. Starting with /** and it has some @ signs to add exceptions, parameters, et al. That is javadoc. Mark
Joined: Feb 26, 2002
Hi Ronnie, get yourself a copy of 'Java in a Nutshell' by O'Reilly. I've found it an invaluable ref for most aspects of the core java API and tools and it's inexpensive (comparatively). check out this link to amazon - Java in a Nutshell - BigC
Joined: Feb 19, 2002
Just check the source of java in src.jar for good java doc. apart from that, i have one question to ask about User/Server doc, as it is worth 10 marks, do we need to put screen shots also there ? what and how much needs to be there ?
"Reddi"- -Rana- Welcome to the JavaRanch! Please adjust your displayed name to meet the JavaRanch Naming Policy. You can change it here. Thanks! and welcome to the JavaRanch!
As for the User documentation. You can either create a nice text fiel that describes how to use your app. Or you can go and create HTML pages of your user docs, add screen shots, and add it to a JScrollPane in a JFrame and make it available from your app. I think this is the coolest, and it isn't that difficult to do. and the surest way to get the entire 10 points. Just do a search on User Doc on this forum and you should get some that explain how to create them. Good Luck Mark