Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Generate and publish documentation with swift-doc#49

Merged
kateinoigakukun merged 5 commits into
masterswiftwasm/JavaScriptKit:masterfrom
swift-docswiftwasm/JavaScriptKit:swift-docCopy head branch name to clipboard
Sep 15, 2020
Merged

Generate and publish documentation with swift-doc#49
kateinoigakukun merged 5 commits into
masterswiftwasm/JavaScriptKit:masterfrom
swift-docswiftwasm/JavaScriptKit:swift-docCopy head branch name to clipboard

Conversation

@MaxDesiatov

@MaxDesiatov MaxDesiatov commented Sep 14, 2020

Copy link
Copy Markdown
Member

You can see the deployment at https://swiftwasm.github.io/JavaScriptKit/.

I'll update the trigger to deploy only on pushes to master if you think this is something we should proceed with.

@MaxDesiatov MaxDesiatov added the documentation Improvements or additions to documentation label Sep 14, 2020
@j-f1

j-f1 commented Sep 15, 2020

Copy link
Copy Markdown
Member

Looks like there’s some cleanup necessary in the “functions” category — all of those should be private imo. It also doesn’t properly handle standard Swift types — is there a way to link those to developer.apple.com?

@MaxDesiatov

Copy link
Copy Markdown
Member Author

I'll clean things up, but cross-module references unfortunately aren't supported in swift-doc yet 😔

@MaxDesiatov

Copy link
Copy Markdown
Member Author

Everything seems to work when @_cdecl functions are made internal, so they are no longer displayed in the docs now.

@MaxDesiatov MaxDesiatov marked this pull request as ready for review September 15, 2020 09:16

@kateinoigakukun kateinoigakukun left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@kateinoigakukun kateinoigakukun merged commit f97dca1 into master Sep 15, 2020
@kateinoigakukun kateinoigakukun deleted the swift-doc branch September 15, 2020 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.