Generated doc is empty

[SeNeO]

I'm using the following script to generate documentation on a test project

~/Documents/appledoc/appledoc
--project-name "Test"
--project-company "Test"
--company-id "com.test"
--output "~/Desktop/appledoctest/"
--logformat xcode
--merge-categories
--no-create-docset
"./testAppleDoc/"

XCode build the target without issue and the files are generated but they are empty, only the static elements are present (index/hierarchy links etc...). I don't know what I'm doing wrong, there is no warning (so I think I'm properly documenting my code), no errors.

As anyone had this kind of issue? I'm pretty sure the issue is on my side and totally dumb but I can't find it...

[torinkwok]

Yep, I met the same issue. I bypass this issue by using appledoc 2.2 (build 963) which can work properly. But all the later versions don't work for me (only the static elements are present).

Here is my Xcode integration script for appledoc:

/usr/local/bin/appledoc
--project-name "ProjectName"
--project-company "Me"
--company-id "xxx.xxx.xxxxx"
--docset-atom-filename "${company}.atom"
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME"
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME"
--docset-fallback-url "${companyURL}/${company}"
--output "${HOME}/${PROJECT_NAME}-Doc"
--publish-docset
--docset-platform-family "${target}"
--logformat xcode
--keep-intermediate-files
--warn-invalid-crossref
--no-repeat-first-par
--no-keep-undocumented-members
--no-search-undocumented-doc
--exit-threshold 2
"~/some/dir"

[SeNeO]

Thanks for the answer, It indeed works with appledoc 2.2 (build 963).

[tomaz]

Try increasing verbosity with --verbose 4 (or greater) to see if there's some meaningful info in log.

[aaronpk]

Thanks, I had to build my docs using appledoc 2.2 build 963 rather than the version that installed using Homebrew.

[ddaws]

I have also experienced this problem using the following build script :

company="AdLyft Inc";
companyID="com.AdLyft";
companyURL="http://adlyft.com";
target="iphoneos";
outputPath="${PROJECT_DIR}/Documentation";

/usr/local/bin/appledoc \
--project-name "${PROJECT_NAME}" \
--project-company "${company}" \
--company-id "${companyID}" \
--docset-atom-filename "${company}.atom" \
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
--docset-fallback-url "${companyURL}/${company}" \
--output "${outputPath}" \
--publish-docset \
--docset-platform-family "${target}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--no-create-docset \
--exit-threshold 2 \
"${PROJECT_DIR}/AdLyft/ADLAdLyftController.h" \
"${PROJECT_DIR}/AdLyft/Models/ADLReward.h" \
"${PROJECT_DIR}/AdLyft/Models/ADLResult.h"

[TorreyBetts]

This happened to me several months ago. In my case, I fixed the issue through the following steps.

1. Delete the ~/.appledoc folder
2. Clone the appledoc repository: git clone git://github.com/tomaz/appledoc.git
3. Add the template option for the installation command: sudo sh install-appledoc.sh -t default

[jameswangz]

This works for me, thanks @TorreyBetts!

[thomasmso]

Still working today! Thanks @TorreyBetts!

[tmcguire]

The installation method described in https://github.com/tomaz/appledoc/issues/561#issuecomment-149327949 worked for me as well.

Installing via homebrew did not work. And indeed the README says that installing via homebrew does not install templates. Maybe the homebrew package should include templates to make it just work?