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

SourceKitten skipping class when generating documentation #663

Open
shariebg opened this issue Aug 10, 2020 · 2 comments
Open

SourceKitten skipping class when generating documentation #663

shariebg opened this issue Aug 10, 2020 · 2 comments

Comments

@shariebg
Copy link

I'm trying to document a project using SourceKitten.The project only contains a Swift file with a class that inherits from NSObject. With the terminal command:

sourcekitten doc -- -workspace ExampleApp.xcworkspace -scheme ExampleService > swiftDoc-example.json

I get the output:

Running xcodebuild
Checking xcodebuild -showBuildSettings
Assuming New Build System is used

and an empty JSON file. I don't know what the problem is because the class is public and the project can be built with Xcode. The class imports some frameworks, which I was able to document successfully. I have created an example class to see if it's at least documented. I also tried /// and /** */ for the class documentation. Unfortunately without success.

I'm desperate and I don't know what to do anymore.

@gagoyal
Copy link

gagoyal commented Oct 25, 2020

I am also facing the exact same issue for my framework target! Any resolution to this please?

@johnfairh
Copy link
Collaborator

If you still have this problem on the latest version then we'll need a sample project to investigate: nothing is out of the ordinary in the setup you've described.

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

3 participants