feat: add standardized file headers with descriptions and MIT license#53
Merged
davidirvine merged 1 commit intodevelopfrom Jul 25, 2025
Merged
feat: add standardized file headers with descriptions and MIT license#53davidirvine merged 1 commit intodevelopfrom
davidirvine merged 1 commit intodevelopfrom
Conversation
- Add comprehensive file header comments to all source files in src/ - Include brief description of each file's purpose and functionality - Add complete MIT license text to ensure proper attribution - Format all files using clang-format to maintain consistency - Headers follow Doxygen documentation style for better tool integration Files updated: - src/voice/deepnotevoice.hpp: Core voice implementation - src/voice/frequencytable.hpp: Frequency table management - src/voice/oscfrequency.hpp: Oscillator frequency utilities - src/ranges/range.hpp: Range constraint utilities - src/ranges/scaler.hpp: Value scaling and mapping - src/unitshapers/bezier.hpp: Bezier curve shaping - src/unitshapers/linear.hpp: Linear unit shaping - src/util/namedtype.hpp: Type-safe wrapper utilities
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds standardized file headers with MIT license information and Doxygen-style documentation to all source files in the Deep Note synthesizer project. The changes ensure proper attribution, improve code documentation, and maintain consistency across the codebase.
- Added comprehensive file headers with MIT license text to all source files
- Included Doxygen-style documentation with file descriptions and author information
- Applied consistent formatting to maintain code style uniformity
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/voice/deepnotevoice.hpp | Added header with description of core voice implementation functionality |
| src/voice/frequencytable.hpp | Added header documenting frequency table management capabilities |
| src/voice/oscfrequency.hpp | Added header describing oscillator frequency calculation utilities |
| src/ranges/range.hpp | Added header explaining range constraint and validation utilities |
| src/ranges/scaler.hpp | Added header documenting value scaling and mapping functionality |
| src/unitshapers/bezier.hpp | Added header describing Bezier curve shaping utilities |
| src/unitshapers/linear.hpp | Added header documenting linear unit shaping capabilities |
| src/util/namedtype.hpp | Added header explaining type-safe wrapper utilities |
|
Coverage after merging std-file-comments into develop will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
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.
Files updated: