Ensure that Javadoc matches spec

rooftopsparrow / resource-locking

Circular Storage with Partial State Operations

MIT License

1 stars 2 forks source link

Ensure that Javadoc matches spec #24

Closed rooftopsparrow closed 7 years ago

rooftopsparrow commented 7 years ago

We need to verify that the docs we can generate from the source code match the provided javadoc specification

hdemarco4 commented 7 years ago

We'll have to take out the 'main' method, it's only there for testing anyway. And everyone who made changes should put themselves as authors. That includes writing tests. It's also saying that there is a FourBit constructor for some reason. I'll mess with it.

hdemarco4 commented 7 years ago

I took out the 'main' method.

arcturas1 commented 7 years ago

Working on the javadoc now.

arcturas1 commented 7 years ago

Javadoc should now be in compliance with spec. Changes as follows:

class description:

added @see with link to project description
(personal preference) provided additional text providing clarification of authorship roles. Probably overkill, but noting who did what is I think valid acknowledgement, and Dr. Paul has not marked me off for doing so in this style for past projects.

Constructor Summary: removed by creating private constructor which does nothing.

rooftopsparrow commented 7 years ago

Closed by MR