Updated Documentation on Parser.java - Githubissues

wakarimasenco / ChanExplorer

MIT License

11 stars 3 forks source link

Updated Documentation on Parser.java #13

Open pavlearezina opened 7 years ago

pavlearezina commented 7 years ago

Changes

Formatted through Sublime indenting, formatted in accordance with JavaDocs, added comments. I have contributed to:

function declaration explanations
removed and edited inline comments
justifying design
added parameter clarifications
asserted conditions that must hold true

This was all done to the file Parser.java

Reason for Pull Request

The file chosen to be documented was a result of an assignment in the SFWR ENG 3I03 class in McMaster Software Engineering.