Exercise 6: Using JavaDoc

due Feb. 22, start of class

You are to use the code fromYOUR CURRENT PROJECT 1 (whichever is more complete) to add comments to in the Javadoc fashion. Making sure you place comments before each class, its variables and methods. Make sure you use at a minimum the following special Javadoc comment features in the appropriate places:

• @author
• @param
• @return
• @since

Then you are to create Javadoc on the commented java file you created. You will then create a Github pages website that needs to be linked off your github repository's wiki under the page titled JavaDoc that you will create.

• Upload all the html content for your JavaDoc to your Github repository you are using for your exercises/Project 1. I suggest you put it in a  /docs folder on the default branch  --you can manually transfer Javadoc usig the Github web interface. First read directions. on how to create Github pages.
• THEN create a Github pages site from this following again these directions.

 

 

View the HTML documentation produced using a Web browser and show the results to your teammates.

 

Deliverables

YOU MUST CREATE REAL DOCUMENTATION

 

Demonstrate to fellow class mates during class ---if you did not succeed this is your SAFTEY check to get help from instructor --THIS EXERCISE IS NOT GRADED

 

EVALUATION DISCLAIMER: Remember this is peer group evaluated and no grade is assigned. Remember peer feedback for this exercise will not indicate if you have done well in this and other areas!!! This exercise is simply to get some level of functionality accomplished and if you want you always have the option to come to office hours to show me your work and ask questions.