feat: API Docs + CommentConverter #32
Merged
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
- Created the project file `Box2D.NET.CommentConverter.csproj` targeting .NET 9.0 - Added a new `Program.cs` file that processes C# files in a specified directory. - Implemented functionality to read files, extract comment lines, and convert single-line comments (//) to XML-style comments (///) wrapped in summary tags.
feat: API Docs
VaclavElias
changed the title
|
Hi @ikpil. Feel free to make any updates. This PR should be working at least as demo-ed here https://www.vaclavelias.com/Box2D.NET/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds docfx configuration and template files and a new GitHub Action, which creates docs in GitHub Pages, probably in https://ikpil.github.io/Box2D.NET.
There is also a very basic comment converter, wrapping // and /// comments into xml summary comment.
Currently the comment converter excludes:
[MethodImp]This PR closes #30