realm / jazzy

Soulful docs for Swift & Objective-C
https://realm.io
MIT License
7.35k stars 413 forks source link

Huge Error Message, Where There Is No Apparent Error (Documentation Works) #1328

Closed ChrisMarshallNY closed 2 years ago

ChrisMarshallNY commented 2 years ago

This concerns this project.

When I run the jazzy.command, script, all the files are parsed, and the resulting documentation appears complete, even though it says "0%."

I get a huge error dump, that starts with:

Running xcodebuild
Parsing LGV_MeetingSDK_Meeting_Protocols.swift (1/9)
Parsing LGV_MeetingSDK_Organization_Protocol.swift (2/9)
Parsing LGV_MeetingSDK_Protocols.swift (3/9)
Parsing LGV_MeetingSDK_Transport_Protocol.swift (4/9)
Parsing LGV_MeetingSDK_BMLT.Transport.Initiator.swift (5/9)
Parsing LGV_MeetingSDK_BMLT.Transport.Parser.swift (6/9)
Parsing LGV_MeetingSDK_BMLT.Transport.swift (7/9)
Parsing LGV_MeetingSDK_BMLT.swift (8/9)
Parsing LGV_MeetingSDK.swift (9/9)
`extraInfo` has no USR. First make sure all modules used in your project have been imported. If all used modules are imported, please report this problem by filing an issue at https://github.com/realm/jazzy/issues along with your Xcode project.
•
•
•
If this token is declared in an `#if` block, please ignore this message.
0% documentation coverage with 0 undocumented symbols
building site
building search index
jam out ♪♫ to your fresh new docs in `docs`

NOTE: The docs are still fairly sparse, but will be getting "meatier," as I progress. This SDK is still under development.

johnfairh commented 2 years ago

What versions of jazzy, Xcode, and macOS are you trying to use?

ChrisMarshallNY commented 2 years ago

Jazzy Version: 0.14.2 Xcode Version 14.0.1 (14A400) MacOS Version 12.6 (21G115)

johnfairh commented 2 years ago

Ok - you'll need jazzy 0.14.3 to work properly with the Swift 5.7 in Xcode 14.

If I use that locally then I get:

[...]
Running xcodebuild
Parsing LGV_MeetingSDK_Meeting_Protocols.swift (1/9)
Parsing LGV_MeetingSDK_Organization_Protocol.swift (2/9)
Parsing LGV_MeetingSDK_Protocols.swift (3/9)
Parsing LGV_MeetingSDK_Transport_Protocol.swift (4/9)
Parsing LGV_MeetingSDK_BMLT.Transport.Initiator.swift (5/9)
Parsing LGV_MeetingSDK_BMLT.Transport.Parser.swift (6/9)
Parsing LGV_MeetingSDK_BMLT.Transport.swift (7/9)
Parsing LGV_MeetingSDK_BMLT.swift (8/9)
Parsing LGV_MeetingSDK.swift (9/9)
100% documentation coverage with 0 undocumented symbols
included 238 public or open symbols
skipped 28 private, fileprivate, or internal symbols
[...]

(this is without your options to minacl etc, don't worry about that!)

ChrisMarshallNY commented 2 years ago

Cool. I did update, but is 0.14.3 a prerelease? It’s not urgent for me. I still am working on live unit tests, and have a lot of documentation ahead, so it will be a couple of weeks before I will need it.

I’ll close the issue. I was just following the instructions in the error dump.

Thanks!

johnfairh commented 2 years ago

Oh don't worry, no problem with your raising this.

I'm not sure what you're asking about 'prerelease' though. 0.14.3 is the latest release of Jazzy from 11th September -- gem install jazzy should install it for you --- it does look OK to me on rubygems.org, but please say if you think there's something wrong with the release.

ChrisMarshallNY commented 2 years ago

Just FYI. Updated to 14.3, and it works.

Thanks!