search

keplersj / BoatCraft

Rails had their turn, now out to the Minecraftian seas.
MIT License
6 stars 7 forks source link

Add Documentation to the Project #185

Closed keplersj closed 10 years ago

keplersj commented 10 years ago

Will merge when "finished" Just putting the request here for discussion.

keplersj commented 10 years ago

All of these documentation comments need some polish.

coveralls commented 10 years ago

Coverage Status

Coverage remained the same when pulling e3ef206ec89f565202c9e3f22349ec4c8235ab83 on build/Documentation into 6ed659f1618ae00f273f1450024f6a77815ccc43 on master.

keplersj commented 10 years ago

It appears that the ScalaDoc generated by Gradle isn't including API documentation, I will look into this.

viliml commented 10 years ago

Yes, I noticed it too. As a matter of fact, it doesn't put the API files in the JAR either! I think we shouldn't actually use the gradle "api" system and just put it all under "main", makes everything easier.

keplersj commented 10 years ago

Sounds good to me. Mind if I do this in master and merge them into build/Documentation and build/Testing?

viliml commented 10 years ago

Sure, however you want.

viliml commented 10 years ago

The changes in master should be merged, and you of the two of us actually know how on earth that works soo...

keplersj commented 10 years ago

A pull request in a pull request? I like it. Lemme make the changes to the build script that I need to and I'll merge then.

keplersj commented 10 years ago

Merged master in and handled most conflicts correctly. Now to 'train' Gradle to give us a ScalaDoc auto-magically. :wink:

coveralls commented 10 years ago

Coverage Status

Coverage remained the same when pulling 26630391d6fe2bc3451303c3f14c6e2c60b973f7 on build/Documentation into 6d9f38a917e5b441ade10706474be88ee048e653 on master.