search

sixones / vitality

Macintosh Eve online skill planner
GNU General Public License v3.0
70 stars 12 forks source link

Start of appledoc-ification of .h files #34

Closed backerman closed 10 years ago

backerman commented 10 years ago

This commit just has src/Core/*.h, but others will follow.

Benefits: Enables automated generation of docset, and appledoc shows up in the Quick Help inspector in XCode.

The new build scheme (Documentation) currently produces a bunch of warnings, but they're all from classes I haven't touched yet that have appledoc-like comments.

Bleyddyn commented 10 years ago

Great idea! And also a good way to familiarize yourself with the code.

I pulled this into a local branch but get an error when building the Documentation: /usr/local/bin/appledoc: No such file or directory

From what I read, the appledoc tool is open source but not installed by default. I'm still willing to merge this pull request, but it would be nice if the extra steps needed were documented somewhere.

One other issue is that some of the comments seem like they are losing information, which I don't think is a good idea. For example, the loadAccount method of the Account class used to have this as part of the comment: Refresh from disk (if the file exists). if not, download from the web

The new comment doesn't mention either the caching or the fact that this method might make network requests, which can be important.

backerman commented 10 years ago

I can definitely add something about installing appledoc.

In the case of loadAccount that deletion was because it doesn't check disk at all; it just downloads a new copy. (The comment also mentioned returning a BOOL but that method is void and therefore doesn't return anything.)