wood burning stoves 2.0*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Summary of uploading process Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Murach's Java Servlets and JSP this week in the Servlets forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Summary of uploading process" Watch "Summary of uploading process" New topic
Author

Summary of uploading process

Roman Rytov
Ranch Hand

Joined: Jun 04, 2001
Posts: 75
I read a lot regarding documenting sources, building jars, writing desing docs and readme.txt. I'd like to summarize my impression about it and discuss with others the result.
1. Java docs.
I create docs for all files (changed, added and original) putting in the docs only public and protected methods' descriptions.
2. I make one desing doc (HTML file) describing all my design choices and the architecture.
3. My jars come together in one jar file and insode are grouped in the next way.
Client.jar - all classes necessary for starting the client without remote stubs.
Server.jar - all classes for the server side.
Doc.jar - design doc and javadoc files.
db.db - the original database file (not jared)
Sources.jar - all sources together
scjd.policy - all permision allowed policy file
README.txt - instructions for an examiner how to unpack and start the server and the client
4. All my jars are accompanied by manifest files and hence selfexecuted.
I haven't done the readme file but there is no reef I hope there.
Please join my topic to enrich ourself together in this pretty stupid area.
[ February 25, 2002: Message edited by: Roman Rytov ]

SCJA, SCJD, MCSD
Mathew Sam
Ranch Hand

Joined: Dec 19, 2001
Posts: 124
What about the user manual ?
Roman Rytov
Ranch Hand

Joined: Jun 04, 2001
Posts: 75
If I forgot - sorry. I did it in HTML format and put it in doc.ajr
Mathew Sam
Ranch Hand

Joined: Dec 19, 2001
Posts: 124
Looks Fine
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Summary of uploading process
 
Similar Threads
Submission doubts/questions
Location of source code in upload jar?
Design Questions
Readme.txt
User Documentation