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

Add documentation comments to public declarations #169

Open
mattt opened this issue May 12, 2020 · 0 comments
Open

Add documentation comments to public declarations #169

mattt opened this issue May 12, 2020 · 0 comments

Comments

@mattt
Copy link
Collaborator

mattt commented May 12, 2020

Surge functionality is, for the most part, "self-documenting". Functions follow standard naming conventions and take typed LHS / RHS arguments in such a way that anyone familiar with the domain shouldn't have much trouble understanding how anything works.

However, providing documentation comments would add support for Xcode help and allow tools like swift-doc to generate a formal API reference. The current approach of organizing functions under MARK headers provides some benefit, but having proper documentation comments would be an improvement.

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

1 participant