coldstar96 / cse403

Budget Manager Project
1 stars 2 forks source link

Add Javadoc comments to the API interface #14

Closed brucec5 closed 11 years ago

brucec5 commented 11 years ago

Add Javadoc comments to the public methods in ApiInterface and ApiCallback.

Also, I changed insert to create in ApiInterface because I think that more closely reflects what they're doing (in a RESTful sense, at least).

Good night.

CardboardAqueduct commented 11 years ago

The javadoc comments look good and fit our style.

I'm not sure if we should change the API callback object to be generic, as java generally prefers generics over casting objects.

brucec5 commented 11 years ago

Alright, I made ApiCallback generic for the type to pass into the onSuccess() callback, and made onFailure() just take in a String with an error message.

I guess if we ever get fancy, I could create a bunch of exception classes that represent possible problems and pass one of those in to onFailure().

CardboardAqueduct commented 11 years ago

Cool, now they're all genericised. The other parts of the code still look good, and that fixes the one concern I had.