Stack Overflow
Stack Overflow

Questions tagged [jazzy]

jazzy is a command-line utility that generates documentation for Swift or Objective-C.

Github page of the (open source) project: https://github.com/realm/jazzy

34 questions
14
votes
2 answers

Jazzy is not working as expected for generating swift documentation

After doing some research on the best way to document swift code. I came across Jazzy and how simple it was to implement. So I follow the installation section of the Jazzy Documentation. I run sudo gem install jazzy Then I navigate to the root of…
A'sa Dickens
  • 2,045
  • 1
  • 16
  • 21
4
votes
2 answers

I am trying to generate documentation from library jazzy,but i am getting following error

The Project is basically made in objective-c language. Jazzy Github Library Running xcodebuild Could not parse compiler arguments from xcodebuild output. Please confirm that xcodebuild is building a Swift module. Saved xcodebuild log file:…
Vishal Jadav
  • 61
  • 8
3
votes
3 answers

Can't install jazzy on Mojave

I was trying to install jazzy on Mojave beta, but failed to do so, because I get this error MacBook-Pro-Damian:~ damiandudycz$ sudo gem install jazzy Password: Building native extensions. This could take a while... ERROR: Error installing jazzy: …
Damian Dudycz
  • 2,622
  • 19
  • 38
3
votes
1 answer

How to get jazzy style docs on cocoapods

I would like to ask how come the docsets of Alamofire and Restofire different. Is there any way i can render the documentation of Restofire to be like Alamofire. When i see below Alamofire documentation, they are generated using jazzy. How to tell…
Rahul Katariya
  • 3,528
  • 3
  • 19
  • 24
3
votes
3 answers

How to use jazzy to document my swift project?

I want to document my swift project, and I find jazzy on the github. after a look at the guide, I create a new simple project and want to have a try, here is my ViewController with some document info: import UIKit /** a view controller */ class…
Xingou
  • 1,141
  • 1
  • 10
  • 20
2
votes
1 answer

Exclude subspecs from podspec with Jazzy swift documentation generation

I'm currently developing an iOS SDK using Cocoapods to manage deployment and Jazzy to generate documentation. I recently added a dependency to Google ads v8 in a subspec, and another dependency to Google ads v7 in another subspec, like this: …
Climbatize
  • 1,103
  • 19
  • 34
2
votes
1 answer

Error while creating documentation with cocoa pods using Jazzy Documentation

I have created a new project [before pod installed]. I am trying to create documentation using jazzy it's creating fine. The commend which I used in terminal jazzy --min-acl internal Then I installed pod file and trying to use same commend in…
KAVIYA VENKAT
  • 337
  • 2
  • 17
2
votes
1 answer

What is docsets folder generated by jazzy

I am working on generating documentation for swift framework and documents are generated by jazzy. Please see the image. This is the generated output folder What is this "docsets" folder. What is the purpose of it ?
Vigneshkumar G
  • 328
  • 1
  • 2
  • 9
2
votes
0 answers

Jazzy 0.7.0 XCode 7.3.1 --exclude is not working

Just wondering if anyone has found a work around for this. Using --exclude using a full file path to a swift file and Jazzy still includes this file / class in the documentation. Shell file looks like this jazzy \ --clean \ --author "Author"…
ort11
  • 3,359
  • 4
  • 36
  • 69
2
votes
0 answers

How to use jazzy with Objective C .m (implementation) files?

I love jazzy, but I struggle with the Objective C process. Many classes are documented well in the .m files but not the .h files. If I put the .m file names in the umbrella header, jazzy blows up. Besides copying the comments to the .h files, is…
Mozahler
  • 4,958
  • 6
  • 36
  • 56
1
vote
1 answer

Why do i get xcodebuild fatal error module map file not found from command line

I have a project which uses SPM (and does not use cocoapods). It compiles and runs fine. I can run SwiftLint autocorrect from the command line and that works too. However, when I try to run jazzy on it, I am getting this error: fatal error: module…
Mozahler
  • 4,958
  • 6
  • 36
  • 56
1
vote
3 answers

Running "bundle exec jazzy" returns error

I try to run jazzy for my project in xcode 11.3 and I get Running xcodebuild Could not successfully run xcodebuild. Please check the build arguments. bundler: failed to load command: jazzy RuntimeError:…
German
  • 413
  • 4
  • 15
1
vote
1 answer

documenting error Jazzy "0% documentation coverage with 0 undocumented symbols"

So I'm trying to run Jazzy to document my code but I'm not getting very far. This is what happens when i run Jazzy on my Xcode project written in swift(and some functions in @ objc). Do i need to prepare the project in any way? I can't find…
Petter Braka
  • 311
  • 1
  • 11
1
vote
1 answer

Incorporating Jazzy documentation generator with Fastlane

I've been able to produce jazzy documentation for my iOS/swift projects and frameworks locally. I'd like to start producing them via Fastlane so that they get updated automatically when they get built on a Jenkins job. I haven't been able to find…
itstillmovesman
  • 13
  • 3
1
vote
0 answers

Jazzy Cannot generate all documentation

I've been having a hard time trying to get more than 10% of the project documented. These are the commands i've been trying jazzy --min-acl internal jazzy --min-acl private jazzy --min-acl private --author 'me' -x…
João Serra
  • 379
  • 1
  • 5
  • 20
1
2 3