Repository navigation
Dokumentationsdateien in eigenes Verzeichnis verschoben - #5
Merged
Merged
Conversation
Füge in `Geometry.vbproj` die `<Folder>`-Einträge für `Doc\ThreeDimensional\` und `Doc\TwoDimensional\` hinzu, damit die Dokumentationsordner im Projektmappen-Explorer berücksichtigt werden.
Dokumentationsordner im Projektfile auf Doc/TwoDimensional und Doc/ThreeDimensional umgestellt; README-Links auf Geometry/Doc/... aktualisiert.
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
Several documented parameter contracts conflict with the corresponding implementations.
0 open findings
What changed in this PR
Moves API documentation into the Geometry/Doc hierarchy and updates project and README references accordingly.
Changes:
- Adds documentation for 19 geometry classes under
Doc. - Updates README links and project inclusions to the new paths.
- Introduces an empty project
ItemGroup.
| File | Description |
|---|---|
README.md |
Updates documentation links. |
Geometry/Geometry.vbproj |
References relocated documentation. |
Geometry/Doc/TwoDimensional/Circle.md |
Documents circle APIs. |
Geometry/Doc/TwoDimensional/Ellipse.md |
Documents ellipse APIs. |
Geometry/Doc/TwoDimensional/Kite.md |
Documents kite APIs. |
Geometry/Doc/TwoDimensional/Parallelogram.md |
Documents parallelogram APIs. |
Geometry/Doc/TwoDimensional/Polygon.md |
Documents polygon APIs. |
Geometry/Doc/TwoDimensional/Rectangle.md |
Documents rectangle APIs. |
Geometry/Doc/TwoDimensional/RegularPolygon.md |
Documents regular-polygon APIs. |
Geometry/Doc/TwoDimensional/Rhombus.md |
Documents rhombus APIs. |
Geometry/Doc/TwoDimensional/Square.md |
Documents square APIs. |
Geometry/Doc/TwoDimensional/Trapezoid.md |
Documents trapezoid APIs. |
Geometry/Doc/TwoDimensional/Triangle.md |
Documents triangle APIs. |
Geometry/Doc/ThreeDimensional/Cone.md |
Documents cone APIs. |
Geometry/Doc/ThreeDimensional/Cube.md |
Documents cube APIs. |
Geometry/Doc/ThreeDimensional/Cuboid.md |
Documents cuboid APIs. |
Geometry/Doc/ThreeDimensional/Cylinder.md |
Documents cylinder APIs. |
Geometry/Doc/ThreeDimensional/Frustum.md |
Documents frustum APIs. |
Geometry/Doc/ThreeDimensional/Prism.md |
Documents prism APIs. |
Geometry/Doc/ThreeDimensional/Pyramid.md |
Documents pyramid APIs. |
Geometry/Doc/ThreeDimensional/Sphere.md |
Documents sphere APIs. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
PR Classification
Dokumentations- und Projektkonfigurationsänderung zur korrekten Einbindung der API-Dokumentation.
PR Summary
Die Dokumentationsdateien wurden im Projekt auf die neuen
Doc\...-Pfade umgestellt, damit sie korrekt als Projektdokumentation eingebunden werden. Zusätzlich wurden die README-Verlinkungen auf die neuen Speicherorte angepasst.Geometry.vbproj: Dokumentationsdateien vonTwoDimensional/ThreeDimensionalnachDoc\TwoDimensionalbzw.Doc\ThreeDimensionalumgehängt und ein leeresItemGroupergänzt.README.md: Verlinkungen auf die Dokumentationsdateien auf die neuenDoc\...-Pfadnamen aktualisiert.