add API comments to source code #566
Open
+363
−61
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
We probably should also eventually write a parser that extracts these comments into markdown or latex format, but this is okay for me right now |
Not at all, the parser of Doxygen works fine, at least for my purpose. I think the most important thing ist, a central place to host the document. gihubpage is also fine for me. |
|
I have made this page as proof of concept: https://felixfuchsff.github.io/asymptote-doc/ |
|
I see. We may have to do some filtering as alot of the documentation are for internal use (i.e. developers working on asy) and not for the end user |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add API comments for Asymptote-authors to
triple.handbase/geometry.asy