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

index.html has no comment of code #611

Open
gshushu opened this issue May 21, 2017 · 9 comments
Open

index.html has no comment of code #611

gshushu opened this issue May 21, 2017 · 9 comments

Comments

@gshushu
Copy link

gshushu commented May 21, 2017

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.

@naftaly
Copy link

naftaly commented Aug 30, 2017

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"

@Insofan
Copy link

Insofan commented Nov 14, 2017

me 2,have you fix it?

@tomaz
Copy link
Owner

tomaz commented Nov 14, 2017

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

@Insofan
Copy link

Insofan commented Nov 14, 2017

@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

@tomaz
Copy link
Owner

tomaz commented Nov 14, 2017

Try changing your comment to:

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

to see what happens

@Insofan
Copy link

Insofan commented Nov 15, 2017

@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}"

@tomaz
Copy link
Owner

tomaz commented Nov 15, 2017

Try also adding some comment to the class itself.

@cslmark
Copy link

cslmark commented May 17, 2019

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

@tmcguire
Copy link

This could be a duplicate of #561 (comment). In that issue, the problem was missing templates, which are not installed when using homebrew to install appledoc.

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

6 participants