search

tomaz / appledoc

Objective-c code Apple style documentation set generator.
http://gentlebytes.com
4.19k stars 645 forks source link

no words in my class document #608

Closed yishuiliunian closed 7 years ago

yishuiliunian commented 7 years ago

i use the command below to generate the document, but no words in my class document. there is no any words.

appledoc --project-name QCLOUDCIClientUIDemo.xcodeproj --project-company=tencent --keep-intermediate --output=~/docs --verbose=6  .

the terminal output

VERBOSE | GBDocSetFinalizeGenerator is generating output...
VERBOSE | Moving DocSet files from '~/docs/docset' to '/Users/dongzhao/Library/Developer/Shared/Documentation/DocSets/com.tencent.qcloudciclientuidemo.xcodeproj.QCLOUDCIClientUIDemo.xcodeproj.docset'...
VERBOSE | Initializing directory at '/Users/dongzhao/Library/Developer/Shared/Documentation/DocSets/com.tencent.qcloudciclientuidemo.xcodeproj.QCLOUDCIClientUIDemo.xcodeproj.docset'...
DEBUG | Removing existing directory...
DEBUG | Creating directory...
DEBUG | Copying '/Users/dongzhao/docs/docset' to '/Users/dongzhao/Library/Developer/Shared/Documentation/DocSets/com.tencent.qcloudciclientuidemo.xcodeproj.QCLOUDCIClientUIDemo.xcodeproj.docset'...
DEBUG | Removing '/Users/dongzhao/Library/Developer/Shared/Documentation/DocSets/com.tencent.qcloudciclientuidemo.xcodeproj.QCLOUDCIClientUIDemo.xcodeproj.docset'...
VERBOSE | Generation step 4/4: Running GBDocSetInstallGenerator...
INFO | Installing DocSet...
VERBOSE | GBDocSetInstallGenerator is generating output...
VERBOSE | Installing DocSet to Xcode...
Generation step 4/4 failed: GBDocSetInstallGenerator failed generating output, aborting!
Documentation set was installed, but couldn't reload documentation within Xcode.
Expected end of line but found identifier.
INFO | Finished generating in 1069ms.
yxf0103 commented 7 years ago

2017-05-08 4 40 39 same issue ,and strange log

tomaz commented 7 years ago

The log suggests appledoc doesn't find documentation on given classes (which would explain why html is empty as well). If you have comments check they have one of valid appledoc syntax (/**, /// etc). If that's also true, you'll have to dig deeper: increase logging verbosity and check the output...

yxf0103 commented 7 years ago

got answer from #473 "Solved the issue by reinstalling appledoc and ensuring the default templates were included."

sudo sh install-appledoc.sh (if you need templates add '-t default')

Thanks tomaz,Thanks emaloney