Docsets not being generated

[mad106]

Hi there,

I couldn't get the docsets created in DerivedData folder. I get a bunch of warnings saying some files aren't documented which I guess means appledoc is running. I used instructions from simplicate blog. Could you help me find the problem?

Here is the command i used in the script under a target i created in my app:

/usr/local/bin/appledoc \
--project-name "fastPark" \
--project-company "Hello" \
--company-id "com.madoneosix" \
--output "~/AppleDoc" \
--install-docset \
--logformat xcode \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--merge-categories \
--exit-threshold 2 \
--docset-platform-family iphoneos \
--ignore "*.m" \
--ignore "Pods" \
--ignore "LoadableCategory.h" \
--ignore "Scringo" \
--ignore "CorePlotHeaders" \
--ignore "GoogleMaps.framework" \
--index-desc "${PROJECT_DIR}/readme.markdown" \
"${PROJECT_DIR}"

Thanks 

[Tom @ Gentle Bytes]

The command line should generate data in ~/AppleDoc folder, if you want to have it in derived data folder, you should change --output switch to something like: --output "$(DERIVED_FILES_DIR)/AppleDoc" or similar, take a look here for a list of available environment variables for Xcode build scripts or run your script phase once and check console to determine desired path: http://stackoverflow.com/questions/6910901/canonical-list-of-xcode-environment-variables

With your cmdline, you probably won't see any output; unless you add --keep-intermediate-files switch, appledoc will remove all intermediate files and install docset to Xcode (because you use --install-docset). Of course if you have this switch on in global settings, you don't have to add it to your build script.

Hope this helps.

Tom

-- 
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 toappledoc+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.

[Rob Van der Veer]

Your doc set is not generated in DerivedData, it is generated in ~/AppleDoc

See if there is a folder named 'fastPark/docset' in there. To properly analyse your issue, please attach the entire build output log, especially the last bit.

[mad106]

Sorry, I failed to mention this, but I changed the output folder only after finding no docsets in the DerivedData folder. It doesn't generate in the new folder as well.

On Tuesday, August 6, 2013 1:05:10 AM UTC-7, Tom wrote:

The command line should generate data in ~/AppleDoc folder, if you want to have it in derived data folder, you should change --output switch to something like: --output "$(DERIVED_FILES_DIR)/AppleDoc" or similar, take a look here for a list of available environment variables for Xcode build scripts or run your script phase once and check console to determine desired path: http://stackoverflow.com/questions/6910901/canonical-list-of-xcode-environment-variables

With your cmdline, you probably won't see any output; unless you add --keep-intermediate-files switch, appledoc will remove all intermediate files and install docset to Xcode (because you use --install-docset). Of course if you have this switch on in global settings, you don't have to add it to your build script.

Hope this helps.

Tom

[Rob Van der Veer]

Please post your output log, either from commandline or from inside xcode. 

—
http://simplicate.weebly.com

[Tom @ Gentle Bytes]

Did you try --keep-intermediate-files option?

[mad106]

Tom & Rob,

I somehow missed a statement in the build log due to many warnings from appledoc, it was saying the template file wasn't found although I had it. Turns out it was nested in a folder, so I took it one level up and it worked. 

Thank you guys, for your help. I just have one more question: Is it possible to section the methods using pragma mark because I have a long list of methods and I would like to appear subsectioned within instance methods or other rmethods.

On Tuesday, August 6, 2013 10:23:34 AM UTC-7, Tom wrote:

Did you try --keep-intermediate-files option?

[Rob Van der Veer]

Use @name to have them sectionized. #pragma mark is not yet supported

—
http://simplicate.weebly.com

[mad106]

You were right, Rob. I overlooked these lines. See my reply to Tom as well. I noticed it only after you mentioning about the last bit in the build log. Thanks!

Generation step 1/3 failed: GBHTMLOutputGenerator failed generating output, aborting!

Object template file 'object-template.html' is missing at '/Users/madhu/Library/Application Support/appledoc/html'!

On Tuesday, August 6, 2013 10:23:05 AM UTC-7, Rob Van der Veer wrote:

Please post your output log, either from commandline or from inside xcode. 

—
http://simplicate.weebly.com

[mad106]

Will do. Thanks

On Tuesday, August 6, 2013 10:37:37 AM UTC-7, Rob Van der Veer wrote:

Use @name to have them sectionized. #pragma mark is not yet supported

—
http://simplicate.weebly.com

[Rob Van der Veer]

I'm glad it is sorted!

[Mike Austin]

I started using apple doc and it's great.. just curious when #pragma mark will be supported to group methods?  It's already a convention, and they're just sitting there not being used.

On Tuesday, August 6, 2013 10:37:37 AM UTC-7, Rob Van der Veer wrote:

Use @name to have them sectionized. #pragma mark is not yet supported

—
http://simplicate.weebly.com