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

Fatal error: not text with HTML tags in Obj-C comments #976

Closed
lilyball opened this issue May 20, 2018 · 5 comments
Closed

Fatal error: not text with HTML tags in Obj-C comments #976

lilyball opened this issue May 20, 2018 · 5 comments

Comments

@lilyball
Copy link

Trying to run jazzy --objc against my project is erroring out with Fatal error: not text: CXCommentKind(rawValue: 3). It appears that a raw value of 3 corresponds to CXComment_HTMLStartTag, and sure enough, my Obj-C documentation has plenty of HTML tags (<tt>foo</tt> for multi-word inline code spans).

@johnfairh
Copy link
Collaborator

This is tracked by jpsim/SourceKitten#409.

@jpsim
Copy link
Collaborator

jpsim commented May 21, 2018

I’m usually in favor of closing duplicate issues but in this case I’d like to keep open, since the dupe is across two different projects.

@MosheBerman
Copy link

MosheBerman commented Mar 29, 2019

Leaving a note here that this is an issue for me as well.

export SOURCEKIT_LOGGING=3;
jazzy \
  --objc \
  --author "Moshe Berman" \
  --clean \
  --umbrella-header ./MyHeader.h \
  --framework-root ./ \
  --output ../docs

I've got lots of HTML comments in my documentation, too. I did a quick search and replace across my project for a few common HTML tags, <em>, <a, and <br />, etc. Converting those manually to markdown seems allows me to build documentation with Jazzy.

@lilyball
Copy link
Author

This is still an issue for me and prevents me from producing Obj-C documentation for my hybrid framework.

@johnfairh
Copy link
Collaborator

Fixed in jazzy 0.13.1 via jpsim/SourceKitten#634.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants