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

General improvements on code, docs, and workflows #84

Merged
merged 29 commits into from
Jul 18, 2023
Merged

Conversation

christianhelle
Copy link
Owner

@christianhelle christianhelle commented Jul 18, 2023

The changes here introduces the following:

  • README file to the core project for NuGet docs
  • Added XML style code documentation to public types in core project
  • Change accessibility of internally-used-only types to internal
  • Add emojis to the workflows (why not...)

…bers

This commit adds XML comments to the 'RefitGeneratorSettings', 'NamingSettings' and 'TypeAccessibility' classes and properties in the Refitter.Core. These comments help explain the purpose and usage of each public member, improving code readability and maintainability.
Changed the access modifier of multiple classes in the Refitter.Core namespace from public to internal. This encapsulates the internal workings of the library better and prevents external misuse. We aim to ensure that only the necessary API surface is exposed for library consumers.
# Conflicts:
#	src/Refitter/README.md
#	src/Refitter/Refitter.csproj
@christianhelle christianhelle added documentation Improvements or additions to documentation enhancement New feature, bug fix, or request labels Jul 18, 2023
@christianhelle christianhelle merged commit cd4d528 into main Jul 18, 2023
@christianhelle christianhelle deleted the development branch July 31, 2023 20:24
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 enhancement New feature, bug fix, or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant