Skip to content
This repository has been archived by the owner on Jan 25, 2019. It is now read-only.

Inline Documentation #38

Open
orta opened this issue Aug 8, 2013 · 7 comments
Open

Inline Documentation #38

orta opened this issue Aug 8, 2013 · 7 comments
Assignees
Milestone

Comments

@orta
Copy link

orta commented Aug 8, 2013

http://cocoadocs.org/docsets/Underscore.m/0.2.1/Classes/USArrayWrapper.html

It'd be cool to have some inline documentation for both Xcode & CocoaDocs 🍺

@robb
Copy link
Owner

robb commented Aug 9, 2013

Does CocoaDocs support TomDoc style comments? That's what I'm leaning towards, personally.

Either way, I'd love to automate the generation of underscorem.org, too!

Edit: Since Underscore.m is also somewhat of a hack in terms of syntax, I'm not sure AppleDoc will pick up the parameters correctly… 😿

@orta
Copy link
Author

orta commented Aug 9, 2013

No, CocoaDocs ( and Xcode 5 ) don't support TomDoc. I imagine support could be added to appledoc, ( there's a thread about this on the ReactiveCococa repo. ) which would at least make it possible for CocoaDocs to work.

This idea of generating a site similar to underscorem.org is definitely something I could do with CocoaDocs ( say if you have under 10 classes, if the site is your design would you mind if I did something similar (but CocoaPods branded) ?

@robb
Copy link
Owner

robb commented Aug 9, 2013

Sure, go ahead.

When you say CocoaPods branded, do you mean mostly cocoa-colored? 🍫

@orta
Copy link
Author

orta commented Aug 9, 2013

Yeah, the colour schemes you see over at http://cocoapod.org - lots of browns & oranges. Don't worry, I'll find a way to make it tasteful, underscorem.org works from the beautiful contrasts so it'll be a thinker with a more constrained colour scheme.

@kvnify
Copy link
Collaborator

kvnify commented Jan 22, 2016

This is pretty old now. Where does this stand? Has something better come up in the last few years that might make this easier? I'd love to get better inline docs in place for sure.

@orta
Copy link
Author

orta commented Jan 22, 2016

This file needs some /// Docs to get it inline in Xcode.

@kvnify
Copy link
Collaborator

kvnify commented Jan 23, 2016

Ok. I'll give the whole thing a one over before we update the pod. I'd love the docs to be there as well. The site is good, but not comprehensive.

@kvnify kvnify self-assigned this Jan 23, 2016
@kvnify kvnify modified the milestones: 0.3.0, 0.4.0 Jan 23, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants