Conversation
I started writing the guidelines for the Doxygen section. Focusing on where to use them, how to write them, core structure and grammar, and giving example templates for comments to be used in File header and above each method. To-do: clean up
I improved the grammar for my section. Also added another 1-2 rules in the "Writing style guidelines". Added more tables with the good and bad examples.
The examples in the Doxygen comment guidelines have been updated and improved. I placed a link to the official C# XML example page.
Member
|
@aZaamBie Weird that it didn't work 🤔 See below: |
These are the following changes made to suit the Linter's standards: - Replaced tab-indents with spacebar-indents. - Removed trailing whitespaces - Table: kept a line free/empty above and below each table. - Added arrow tags <>, to every bare URL used.
This SHOULD be the remaining fixes for the linting issues. I was using 2 spaces for indentation (because md007 tells us to use 2 in the example_) but am now using 4 spaces.
Collaborator
Author
|
Linting issues are no more!!! 🔥 |
Member
aZaamBie
changed the title
aZaamBie
changed the title
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
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.
The Doxygen usage and writing guidelines have been added into the staging branch.
I focused on three major sections:
I worked on this using VScode and the Markdown Preview extension.
NOTE: I couldn't run Preview.py properly. It started the server but always ended up on a localhost:8080 error, saying
Thus, I used the extension for a live preview and generating HTML pages. The emoji's worked on both exports.