Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generated doc is empty #561

Open
SeNeO opened this issue Sep 23, 2015 · 9 comments
Open

Generated doc is empty #561

SeNeO opened this issue Sep 23, 2015 · 9 comments

Comments

@SeNeO
Copy link

SeNeO commented Sep 23, 2015

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
Copy link
Contributor

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
Copy link
Author

SeNeO commented Sep 23, 2015

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

@tomaz
Copy link
Owner

tomaz commented Sep 25, 2015

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

@aaronpk
Copy link

aaronpk commented Oct 13, 2015

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

@ddaws
Copy link

ddaws commented Oct 19, 2015

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
Copy link
Contributor

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
Copy link

This works for me, thanks @TorreyBetts!

@thomasmso
Copy link

Still working today! Thanks @TorreyBetts!

@tmcguire
Copy link

The installation method described in #561 (comment) 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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

9 participants