Comments (6)
@johnfairh - Thanks for your quick response, I followed the link and tried the steps as stated.
when i run below clang command, it executed successfully
>>clang -c -x objective-c -isysroot $(xcrun --show-sdk-path) -I $(pwd) Infinite/Infinite/Infinite.h -fmodules
After that i ran below Jazzy command, it executed successfully but not generated any documentation.
jazzy --objc --umbrella-header Infinite/Infinite/Infinite.h --framework-root $(pwd)
0% documentation coverage with 2 undocumented symbols
included 2 symbols
building site
building search index
jam out ♪♫ to your fresh new docs in `docs`
I also tried SourceKitten command to generate the ObjectiveC json file but no luck.
sourcekitten doc --objc $(pwd)/Infinite/Infinite/Infinite.h -- -x objective-c -I $(pwd) Infinite/Infinite/Infinite.h -fmodules > objcDoc.json
zsh: trace trap sourcekitten doc --objc $(pwd)/Infinite/Infinite/Infinite.h -- -x objective-c
Could you please help us in generating the documentation for attached codebase.
Modular.zip
from jazzy.
Here's what happens when I run the clang command you say works for you:
; clang -c -x objective-c -isysroot $(xcrun --show-sdk-path) -I $(pwd) Infinite/Infinite/Infinite.h -fmodules
Infinite/Infinite/Infinite.h:19:9: fatal error: 'Infinite/NSString+DateFormatter.h' file not found
#import <Infinite/NSString+DateFormatter.h>
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...and I can see that the NSString+DateFormatter.h
file's path is:
; find . -name NSString+DateFormatter.h
./Infinite/Infinite/PublicAPI/NSString+DateFormatter.h
So this is exactly the problem that the link I posted above describes -- you need to decide how you want to solve it. Then when you have the clang
command working correctly (ie. no error messages) you can pass the same flags to sourcekitten
to generate the objcDoc.json
.
from jazzy.
I think just a slight copy+paste mistake, the umbrella header file is appearing twice in the sourcekitten command which clang is not going to like. The command should be something like:
sourcekitten doc --objc $(pwd)/Infinite/Infinite/Infinite.h -- -x objective-c -isysroot $(xcrun --show-sdk-path) -I $(pwd) -fmodules
And check your very first comment - if your project is for iOS then you'll need to put back the --sdk iphonesimulator
.
from jazzy.
It looks like you need some more build flags to tell Clang where the headers are -- try reading around these notes.
from jazzy.
Hello @johnfairh,
I tried to add symbolic link in the below attached project and executed clang command. Command executed successfully.
clang -c -x objective-c -isysroot $(xcrun --show-sdk-path) -I $(pwd) Infinite/Infinite/Infinite.h -fmodules
As suggested above I tried same command with sourcekitten and im getting below error. Attached screenshot for reference.
clang -c -x objective-c -isysroot $(xcrun --show-sdk-path) -I $(pwd) Infinite/Infinite/Infinite.h -fmodules
geethadevi@INCHEL-GXTG90HJ-7903 Modular % sourcekitten doc --objc $(pwd)/Infinite/Infinite/Infinite.h -- -x objective-c -isysroot $(xcrun --show-sdk-path) -I $(pwd) Infinite/Infinite/Infinite.h -fmodules
zsh: trace trap sourcekitten doc --objc $(pwd)/Infinite/Infinite/Infinite.h -- -x objective-c
from jazzy.
@johnfairh Thanks a lot for your support. It's working fine and able to generate documentation successfully.
from jazzy.
Related Issues (20)
- Sections Parameters, Declaration and Return Value not generated HOT 3
- Search option is not working. HOT 1
- The installation of jazzy through gem does not work (OSX 13.4.1 / XCode 14.3.1) HOT 2
- How does Jazzy keep track of what percent of documentation is completed? HOT 4
- How does Jazzy keep track of what percent of documentation is completed? HOT 1
- Many errors reported on valid source HOT 2
- Jazzy chokes on target names containing '-' HOT 2
- Xcode 15: Unknown symbol kind swift.extension HOT 4
- Runtime error in running jazzy: undefined method `deprecator' for ActiveSupport:Module (NoMethodError) HOT 3
- zsh: no matches found: --documentation=./*.md HOT 1
- iOS only SPM won't build HOT 2
- Missing docs with @available(iOSApplicationExtension, unavailable) and APPLICATION_EXTENSION_API_ONLY = YES HOT 4
- Can't exclude files generated during build. HOT 2
- Error generating documentation: Could not find SPM module HOT 3
- Type alias link generation is not working properly in M1 HOT 2
- No parameters listed for `init` methods from symbolgraph. HOT 2
- Cannot Execute Jazzy that's installed using Bundler on XCode 15.2 HOT 4
- Is it possible to run jazzy as a phase of XCode Build Phases? HOT 3
- `block in next_doc_module_group': undefined local variable or method `_1' for Jazzy::SourceKitten:Module (NameError) HOT 4
- Loading sourcekitdInProc.framework/Versions/A/sourcekitdInProc failed HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jazzy.