Code documentation (Please read and comment everyone)

[bjumbeck]

Hey everyone,

One thing we need to do is fully document our project's code-base. We can do this really easy by using Javadoc. I have already generated documentation on most if not all the methods in our project so that should be pretty much done.

But I could use some help with some other things related to that.

1. Going through all that documentation and making sure everything is right or if anything can be improved upon. Things like explains what a method does correctly and in a easy to understand way.

2. Adding in the requirement tag for all the places in our code where we met a certain requirement for the final. In the assignment text it says we need to have at least 5 out of the 10 categories used in our code and they need to be pointed out in comments that they fill that requirement. The categories are as follows.

• Arrays
• Inheritance
• Interface dependent Polymorphism (interface you create)
• Software development (JAR packaging and exception handling)
• Regex
• I/O & object serialization (at least for some output)
• Lambdas
• Generic classes & methods (used throughout program; include those devised by you)
• Recursion
• Concurrency

So if anyone has any extra time and doesn't have anything they need to work on could they go through our code-base and find where we met any of these requirements? When you do find somewhere that meets one of the requirements all you have to do is add a line like this * @final.requirement Satisfies the __________ requirement. to it's Javadoc comment.

For example here is one from the TestUtilities class which met the generic and recursive requirement.

/**
     * Creates a custom line of the specified character on the standard output.
     *
     * @param length        The number of characters you want the line to be.
     * @param lineCharacter The character you want the line to be made up of.
     * @final.requirement Satisfies the recursion and generic requirements for the final.
     */
    public static <T> void line(int length, T lineCharacter) {
        if (length <= 0) {
            // Drop to a new line after printing out a line
            System.out.print("\n");
        } else {
            System.out.print(lineCharacter);
            line(length - 1, lineCharacter);
        }
    }

Thanks in advance to anyone who can help with this and if you need any help with figuring out how to document things with Javadoc can post here and I can help explain it more in detail or answer any question.