rsanchez-wsu / jfiles

A Java-based file browser
GNU General Public License v3.0
20 stars 9 forks source link

Add thorough documentation to wiki #224

Open kryan100 opened 7 years ago

kryan100 commented 7 years ago

Improved on to avoid confusion for next semester. Unless we determine otherwise, the wiki could still use documentation for:

SolidStateHero commented 7 years ago

@rsanchez-wsu I'm looking through the issues to clean them up. I'm missing the context of what team created this and whether or not this was meant to be for one single team or all teams?

rsanchez-wsu commented 7 years ago

@willeko999x This was a team 4 issue. I recommend asking @viro101 for advice/suggestions on this. If he has nothing illuminating to offer on this, then it is OK to close. I expect that the first two items will eventually be handled under #231 and the third item will eventually be covered through incremental improvements to the code.

kryan100 commented 7 years ago

A bit late, but if you haven't contacted viro yet, the first item references everything contained within the "core" folder. I documented a bit of it before the semester ended, and it looks like someone was able to expand and format it better.

231 seems to address the second item. Team 4 intended to use the Core files that were imported from somewhere™ as the format for commands and for the tools to parse input passed from the client. The proposal seems to be pretty close to what we had in mind.

The third item refers to the code in the switch statement of JFilesServer.java starting about line 270. I think this is the major point to hit before closing this issue. We implemented a method of recording commands and search patterns passed by the user into text files. The documentation on this is basically nonexistent. There should be comments in the code and a page on the wiki to ensure others understand why executing commands creates two new text files. The command history will be useful from a command line perspective for being able to quickly execute previous commands. The search history can be useful in the event you want to add a autocomplete option for frequently searched items.

rsanchez-wsu commented 7 years ago

@kryan100 Thanks for the additional information!