Documentation only for public .h files

[Michael]

Hello,

I would like to know whether it is possible to generate the documentation only for the files that are listed in Copy Files Build Phase of the target.

I want to generate a docset for iOS framework (static lib) and definitely don't want to generate docs for the internal classes - the ones that are invisible for the developers that integrate this framework in their projects.

Currently the documentation includes all the classes that exist in the project.

Thank you.

[Tom @ Gentle Bytes]

This should definitely be doable!

The simplest way of doing this would be if you have public headers in a separate folder (can be post-compile copy script if you don't want to separate them in Xcode.

Another option would be to list each individual public header as source path in appledoc cmdline (you're not limited to single source path, not does it need to be a folder). Not sure if there's simple way of using Xcode environment variables for this though. You could do it manually but that would not be very future proof I guess.

Third option is using ignore arguments (which you can also supply in any number). This way you can give it single source path and any number of ignore paths.

Check wayback machine for some docs: http://web.archive.org/web/20120615152942/http://gentlebytes.com/appledoc-docs-examples-basic/ (I still didn't find the time to bring it over to new website)

--

Sent from my iPad

--
You received this message because you are subscribed to the Google Groups "appledoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email to appledoc+u...@googlegroups.com.
To post to this group, send email to appl...@googlegroups.com.
Visit this group at http://groups.google.com/group/appledoc.
For more options, visit https://groups.google.com/groups/opt_out.