Doc improvements
Reported by Stephen Ierodiaconou | March 1st, 2009 @ 02:37 AM | in 0.7
Mainpage: Adding README and LICENSE to doxygen docs, included in HTML preformatted tags directly from the original text files to avoid duplicating all the information and thus having only one source to update. This is a little crude but I feel its the most maintainable method for now.
Its in Foundation.j though a new file would prob be more appropriate.
Groups: Also defined 2 groups , appkit and foundation to @ingroup the classes accordingly.
Descriptions: class descriptions for the Class list need adding.
Missing Method Fixes: Add @cond for classes with missing methods as per Vladimir's suggestion: /// @cond DOXYFIX /// @endcond
Comments and changes to this ticket
-
-
Stephen Ierodiaconou March 1st, 2009 @ 03:58 AM
Im adding doxygen comments here and there in the source , (however Im not 100% sure what to write for some classes as im not sure if there are subtle differences with Cocoa so wont be able to do everything).
Should i make commits for each class separately to make it easier to later pick and choose what, if anything, is actually merged into the main branch?
-
Stephen Ierodiaconou March 1st, 2009 @ 04:14 AM
sorry, in that commit the defgroups cannot be at the top of the comment, otherwise the imports are added the group name... ??
anyway here is the fixed commit
-
Farcaller March 1st, 2009 @ 11:26 PM
I think I'll add add info on what I'm working now so we wouldn't collide with patches.
I've got extended documentation for CPObject, CPArray, working on CPDictionary and will switch to CPString next. Mostly that are method descriptions and examples for people not familiar with Cocoa.
-
Stephen Ierodiaconou March 1st, 2009 @ 11:49 PM
- Tag changed from “@to-review, @working-on” to “@to-review, @working-on, documentation”
ok cool, well I will work simply on adding the @ingroup and @brief to as many classes as possible and also adding the DOXYFIX conditions.
If I comment a class, such as CPDate I will post here so we dont overlap.
do you have a git fork I can follow?
-
Farcaller March 2nd, 2009 @ 02:29 AM
Not yet, I'm working mostly with local patches stack on stgit. I'll clean up local tree and push it to github soon.
-
Stephen Ierodiaconou March 24th, 2009 @ 11:53 PM
- Tag changed from “@to-review, @working-on, documentation” to “@to-review, documentation”
This should prob be closed (i think the @mainpage stuff has been merged anyway already) as if specific docs for a specific class are generated they warrant their own ticket.
-
Ross Boucher April 19th, 2009 @ 09:10 AM
- Milestone set to “0.7”
- State changed from “new” to “resolved”
Please Sign in or create a free account to add a new ticket.
With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.
Create new ticket
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป
The Cappuccino Web Framework, including AppKit, Foundation, and Objective-J.
Farcaller
Ross Boucher
Stephen Ierodiaconou