oleksii-demedetskyi / Parus

Parus is simple chain style auto-layout helper for objective-c.
MIT License
106 stars 4 forks source link

Lib should have full documentation generated from source code using appledoc. #2

Closed oleksii-demedetskyi closed 10 years ago

oleksii-demedetskyi commented 11 years ago

appledoc comment style now supported by XCode 5 documentation module, so we need include all comments to all methods.

Forsarion commented 11 years ago

Common way of adding appledoc to the project is to create target which will include script that will force appledoc to generate documentation. Note: Appledoc installation guide should be added to wiki. Questions: @DAlOG Do we need to store documentation inside the repository or we need to just ignore folder that will contain generated documentation?

oleksii-demedetskyi commented 11 years ago

I think about it. At one side we have appledoc as standart for many libs. But XCode 5 will drop custom docset support, and will grab documentation from source files. I think we need to look at GitHub doc standards.

https://github.com/github/objective-c-conventions

This file specify main principle, i think we should follow this principle and generate human readable documentation.

oleksii-demedetskyi commented 11 years ago

Anyway, we need check XCode 5 info before starting any documentation.

xNekOIx commented 10 years ago

@DAlOG @AndreyMoskvin As far as I remember we've already done this. Please confirm and close.

oleksii-demedetskyi commented 10 years ago

done.