appledoc icon indicating copy to clipboard operation
appledoc copied to clipboard

index.html has no comment of code

Open gshushu opened this issue 7 years ago • 9 comments

Create doc success(guess) ,in the content of file, index.html just has a name of Class , no property, no method, it's empty.just Index, Hierarchy, and On this page list.

gshushu avatar May 21 '17 04:05 gshushu

same results here. Not exactly sure what changed. here the cmd I use:

/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 \
--use-code-order \
--no-install-docset \
--create-html \
--create-docset \
--keep-undocumented-objects \
--keep-undocumented-members \
--repeat-first-par \
--print-information-block-titles \
--use-single-star \
--ignore .m \
--ignore .mm \
--ignore Releases \
--ignore Frameworks \
--exit-threshold 2 \
"${PROJECT_DIR}/file1.h" \
"${PROJECT_DIR}/file2.h" \
"${PROJECT_DIR}/file3.h" \
"${PROJECT_DIR}/file4.h"

naftaly avatar Aug 30 '17 14:08 naftaly

me 2,have you fix it?

Insofan avatar Nov 14 '17 10:11 Insofan

Did you try debugging with --verbose setting to see what gets parsed? Use at least 5 to get this much data to output...

tomaz avatar Nov 14 '17 11:11 tomaz

@tomaz I write this in m ` @interface MainTableViewController ()

/*! @brief This property knows View Controller array. */ @property (strong, nonatomic) NSArray *vcArray; @end ` and type sub in terminal

appledoc --verbose 5 --no-create-docset --output ./doc --project-name Insofan --project-company "Insofan" --company-id "com.Insofan" .\/ teminal says WARN | MainTableViewController is not documented! no comment in index and it seems didn't support cocoapod's framework. I have to clean pods use appledoc then reinstall pods

Insofan avatar Nov 14 '17 11:11 Insofan

Try changing your comment to:

/**
This property knows View Controller array.
*/

to see what happens

tomaz avatar Nov 14 '17 12:11 tomaz

@tomaz Still nothing.Btw, my project on xcode9 and deleted pods. sub is my script

#appledoc Xcode script
  # Start constants
company="Insofan";
companyID="com.Insofan";
companyURL="https://github.com/insofan";
target="iphoneos";
 #target="macosx";
outputPath="~/help";\

/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 \
--exit-threshold 2 \
"${PROJECT_DIR}"

Insofan avatar Nov 15 '17 05:11 Insofan

Try also adding some comment to the class itself.

tomaz avatar Nov 15 '17 06:11 tomaz

Xcode10 the same result. it's empty.just Index, Hierarchy, and On this page list. How to solve it!

cslmark avatar May 17 '19 11:05 cslmark

This could be a duplicate of https://github.com/tomaz/appledoc/issues/561#issuecomment-149327949. In that issue, the problem was missing templates, which are not installed when using homebrew to install appledoc.

tmcguire avatar Oct 26 '20 13:10 tmcguire