Compare commits
31 Commits
1.1.2
..
development
| Author | SHA1 | Date | |
|---|---|---|---|
| d9289d8eb2 | |||
| b39763c104 | |||
| 1a4eb80696 | |||
| 0e4819a5a2 | |||
| 7d3729db01 | |||
| a53e669bc1 | |||
| 73a3c3cbe5 | |||
| 56f4c88f4b | |||
| 5d45842274 | |||
| 192ab04f89 | |||
| d791145f95 | |||
| 65dc996a22 | |||
| 43acc83207 | |||
| a6cd274cc4 | |||
| e3ca453144 | |||
| 3c4d726f40 | |||
| c8c61573d8 | |||
| 17d0a1d57c | |||
| 73a7983b7e | |||
| 4e131d158c | |||
| dc18f79a7e | |||
| 27a3408828 | |||
| d20a80c44c | |||
| ac91759807 | |||
| f0d9c49f6d | |||
| ab700413fb | |||
| 9d27ec0ac9 | |||
| 6681523a85 | |||
| 53650e4bfe | |||
| b8a3a78e1d | |||
| a9e4106212 |
@@ -0,0 +1,15 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: omegaleo # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: omegaleo # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
||||
polar: # Replace with a single Polar username
|
||||
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
|
||||
thanks_dev: # Replace with a single thanks.dev username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: "[BUG]"
|
||||
labels: bug
|
||||
assignees: omegaleo
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: omegaleo
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
Regular → Executable
+34
-14
@@ -6,35 +6,55 @@ on:
|
||||
description: 'Tag name:'
|
||||
type: string
|
||||
required: true
|
||||
run-name: "Generating changelog for Release v${{github.event.inputs.tagName}}"
|
||||
run-name: "Generating changelog and Creating Tag for Release v${{github.event.inputs.tagName}}"
|
||||
jobs:
|
||||
generate_changelog:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.head_ref }}
|
||||
ref: ${{ github.ref }}
|
||||
token: ${{ secrets.TOKEN }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v1
|
||||
uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: '8.0.x'
|
||||
- name: Update Project Versions
|
||||
dotnet-version: '9.0.x'
|
||||
|
||||
- name: Update OmegaLeo.HelperLib Version
|
||||
run: sed -i "s/\(<Version>\)[0-9]\+\.[0-9]\+\.[0-9]\+/\1${{github.event.inputs.tagName}}/" "./OmegaLeo.HelperLib/OmegaLeo.HelperLib.csproj"
|
||||
|
||||
- name: Update Project Versions
|
||||
- name: Update OmegaLeo.HelperLib.Changelog Version
|
||||
run: sed -i "s/\(<Version>\)[0-9]\+\.[0-9]\+\.[0-9]\+/\1${{github.event.inputs.tagName}}/" "./OmegaLeo.HelperLib.Changelog/OmegaLeo.HelperLib.Changelog.csproj"
|
||||
|
||||
- name: Build and Run Changelog Generator
|
||||
run: dotnet run --project "./OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj"
|
||||
|
||||
- name: Update OmegaLeo.HelperLib.Documentation Version
|
||||
run: sed -i "s/\(<Version>\)[0-9]\+\.[0-9]\+\.[0-9]\+/\1${{github.event.inputs.tagName}}/" "./OmegaLeo.HelperLib.Documentation/OmegaLeo.HelperLib.Documentation.csproj"
|
||||
|
||||
- name: Update OmegaLeo.HelperLib.Game Version
|
||||
run: sed -i "s/\(<Version>\)[0-9]\+\.[0-9]\+\.[0-9]\+/\1${{github.event.inputs.tagName}}/" "./OmegaLeo.HelperLib.Game/OmegaLeo.HelperLib.Game.csproj"
|
||||
|
||||
- name: Update OmegaLeo.HelperLib.Shared Version
|
||||
run: sed -i "s/\(<Version>\)[0-9]\+\.[0-9]\+\.[0-9]\+/\1${{github.event.inputs.tagName}}/" "./OmegaLeo.HelperLib.Shared/OmegaLeo.HelperLib.Shared.csproj"
|
||||
|
||||
- name: Build Solution
|
||||
run: dotnet build --configuration Release
|
||||
|
||||
- name: Run Changelog Generator
|
||||
run: dotnet run --project "./OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj" --configuration Release
|
||||
env:
|
||||
UNITYFLOW_SECRET: ${{ secrets.TOKEN }}
|
||||
- name: Create Tag
|
||||
TAG_VERSION: ${{ github.event.inputs.tagName }}
|
||||
|
||||
- name: Commit and Push Changes
|
||||
run: |
|
||||
git config --local user.email "nunodiogo@omegaleo.pt"
|
||||
git config --local user.name "Nuno Diogo"
|
||||
git add .
|
||||
git commit -m "Automatically generated changelog for v${{github.event.inputs.tagName}}"
|
||||
git diff --staged --quiet || git commit -m "chore: update changelog and version to v${{github.event.inputs.tagName}}"
|
||||
git push origin ${{ github.ref }}
|
||||
|
||||
- name: Create and Push Tag
|
||||
run: |
|
||||
git tag -a "${{ github.event.inputs.tagName }}" -m "Release ${{ github.event.inputs.tagName }}"
|
||||
git push origin "${{ github.event.inputs.tagName }}"
|
||||
git push origin "${{ github.event.inputs.tagName }}"
|
||||
|
||||
Regular → Executable
Regular → Executable
+48
@@ -89,3 +89,51 @@ jobs:
|
||||
asset_path: ./OmegaLeo.HelperLib.Game/bin/Release/OmegaLeo.HelperLib.Game.${{ github.event.release.tag_name }}.nupkg
|
||||
asset_name: OmegaLeo.HelperLib.Game.${{ github.event.release.tag_name }}.nupkg
|
||||
asset_content_type: application/zip
|
||||
publish-doc-lib:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [ get-release ]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Setup .Net Core
|
||||
uses: actions/setup-dotnet@v1
|
||||
with:
|
||||
dotnet-version: '8.0.x'
|
||||
- name: Update Project Version
|
||||
run: sed -i "s/\(<Version>\([0-9]\+\.\)\{2\}\)\([0-9]\+\)/\1${{ github.event.release.tag_name }}/" "./OmegaLeo.HelperLib.Documentation/OmegaLeo.HelperLib.Documentation.csproj"
|
||||
- name: Create Nuget Package
|
||||
run: dotnet pack "./OmegaLeo.HelperLib.Documentation/OmegaLeo.HelperLib.Documentation.csproj" -c Release /p:Version=${{ github.event.release.tag_name }} /p:PackageReleaseNotes="See https://github.com/omegaleo/OmegaLeo.HelperLib/releases/tag/${{ github.event.release.tag_name }}"
|
||||
- name: Publish Nuget Package
|
||||
run: dotnet nuget push ./OmegaLeo.HelperLib.Documentation/bin/Release/OmegaLeo.HelperLib.Documentation.${{ github.event.release.tag_name }}.nupkg --api-key ${{ secrets.nuget_api_key }} --source https://api.nuget.org/v3/index.json --skip-duplicate
|
||||
- name: Upload assets to release
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ needs.get-release.outputs.upload_url }}
|
||||
asset_path: ./OmegaLeo.HelperLib.Documentation/bin/Release/OmegaLeo.HelperLib.Documentation.${{ github.event.release.tag_name }}.nupkg
|
||||
asset_name: OmegaLeo.HelperLib.Documentation.${{ github.event.release.tag_name }}.nupkg
|
||||
asset_content_type: application/zip
|
||||
publish-shared-lib:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [ get-release ]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Setup .Net Core
|
||||
uses: actions/setup-dotnet@v1
|
||||
with:
|
||||
dotnet-version: '8.0.x'
|
||||
- name: Update Project Version
|
||||
run: sed -i "s/\(<Version>\([0-9]\+\.\)\{2\}\)\([0-9]\+\)/\1${{ github.event.release.tag_name }}/" "./OmegaLeo.HelperLib.Shared/OmegaLeo.HelperLib.Shared.csproj"
|
||||
- name: Create Nuget Package
|
||||
run: dotnet pack "./OmegaLeo.HelperLib.Shared/OmegaLeo.HelperLib.Shared.csproj" -c Release /p:Version=${{ github.event.release.tag_name }} /p:PackageReleaseNotes="See https://github.com/omegaleo/OmegaLeo.HelperLib/releases/tag/${{ github.event.release.tag_name }}"
|
||||
- name: Publish Nuget Package
|
||||
run: dotnet nuget push ./OmegaLeo.HelperLib.Shared/bin/Release/OmegaLeo.HelperLib.Shared.${{ github.event.release.tag_name }}.nupkg --api-key ${{ secrets.nuget_api_key }} --source https://api.nuget.org/v3/index.json --skip-duplicate
|
||||
- name: Upload assets to release
|
||||
uses: actions/upload-release-asset@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.TOKEN }}
|
||||
with:
|
||||
upload_url: ${{ needs.get-release.outputs.upload_url }}
|
||||
asset_path: ./OmegaLeo.HelperLib.Shared/bin/Release/OmegaLeo.HelperLib.Shared.${{ github.event.release.tag_name }}.nupkg
|
||||
asset_name: OmegaLeo.HelperLib.Shared.${{ github.event.release.tag_name }}.nupkg
|
||||
asset_content_type: application/zip
|
||||
@@ -0,0 +1,43 @@
|
||||
# Simple workflow for deploying static content to GitHub Pages
|
||||
name: Deploy static content to Pages
|
||||
|
||||
on:
|
||||
# Runs on pushes targeting the default branch
|
||||
push:
|
||||
branches: ["main"]
|
||||
|
||||
# Allows you to run this workflow manually from the Actions tab
|
||||
workflow_dispatch:
|
||||
|
||||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
||||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
# Single deploy job since we're just deploying
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: Setup Pages
|
||||
uses: actions/configure-pages@v5
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
# Upload entire repository
|
||||
path: '.'
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
Regular → Executable
+10
-1
@@ -2,4 +2,13 @@ bin/
|
||||
obj/
|
||||
/packages/
|
||||
riderModule.iml
|
||||
/_ReSharper.Caches/
|
||||
/_ReSharper.Caches/
|
||||
/.vs
|
||||
<<<<<<< Updated upstream
|
||||
/OmegaLeo.HelperLib.Web
|
||||
=======
|
||||
/OmegaLeo.HelperLib.Web/.config
|
||||
/OmegaLeo.HelperLib.Web/Properties/PublishProfiles
|
||||
/OmegaLeo.HelperLib.Web/publish
|
||||
>>>>>>> Stashed changes
|
||||
/OmegaLeo.HelperLib.Web/OmegaLeo.HelperLib.Web.csproj.user
|
||||
|
||||
Generated
Regular → Executable
Generated
Regular → Executable
Regular → Executable
Regular → Executable
@@ -1,21 +1,661 @@
|
||||
MIT License
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (c) 2024 Nuno "Omega Leo" Diogo
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
Preamble
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
using System;
|
||||
using NetFlow.DocumentationHelper.Library.Attributes;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Changelog.Attributes
|
||||
{
|
||||
[Changelog("v1.0.0", "Created ChangelogAttribute to be used to register changes in the code.")]
|
||||
[Documentation(nameof(ChangelogAttribute), "Attribute to annotate classes, methods, or properties with changelog information.")]
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property, AllowMultiple = true)]
|
||||
public class ChangelogAttribute : Attribute
|
||||
{
|
||||
public string Version { get; }
|
||||
public string Description { get; }
|
||||
|
||||
public ChangelogAttribute(string version, string description)
|
||||
{
|
||||
Version = version;
|
||||
Description = description;
|
||||
}
|
||||
}
|
||||
}
|
||||
Regular → Executable
+10
-4
@@ -1,7 +1,13 @@
|
||||
# Changelog
|
||||
# Changelog
|
||||
## Version 1.2.0
|
||||
|
||||
## Version v1.0.0
|
||||
**OmegaLeo.HelperLib.Changelog.Helpers**
|
||||
- **ChangelogHelper**:
|
||||
- Created ChangelogHelper to generate markdown from changelog attributes.
|
||||
|
||||
- **Class: ChangelogTool**: Created the class ChangelogTool to extract changelogs via attributes
|
||||
- **Class: ChangelogAttribute**: Created ChangelogAttribute to be used to register changes in the code.
|
||||
## Version 1.0.0
|
||||
|
||||
**OmegaLeo.HelperLib.Changelog.Tools**
|
||||
- **ChangelogTool**:
|
||||
- Created the class ChangelogTool to extract changelogs via attributes
|
||||
|
||||
|
||||
@@ -0,0 +1,114 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Text;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Changelog.Helpers
|
||||
{
|
||||
[Documentation(nameof(ChangelogHelper),
|
||||
"Helper class to generate changelog markdown from ChangelogAttributes in the provided Assemblies.")]
|
||||
[Changelog("1.2.0", "Created ChangelogHelper to generate markdown from changelog attributes.")]
|
||||
public static class ChangelogHelper
|
||||
{
|
||||
[Documentation(nameof(GetChangelogMarkdown),
|
||||
"Generates a markdown formatted changelog from the changelog attributes in the provided assemblies.")]
|
||||
public static string GetChangelogMarkdown(IEnumerable<Assembly> assemblies)
|
||||
{
|
||||
var changelog = new StringBuilder();
|
||||
var entriesByVersionDate =
|
||||
new Dictionary<(string Version, string Date),
|
||||
Dictionary<string, List<(string ClassName, string Description)>>>();
|
||||
|
||||
foreach (var assembly in assemblies)
|
||||
{
|
||||
try
|
||||
{
|
||||
foreach (var type in assembly.GetTypes())
|
||||
{
|
||||
// Get type-level changelog attributes
|
||||
var typeAttrs = type.GetCustomAttributes<ChangelogAttribute>().ToList();
|
||||
|
||||
// Get member-level changelog attributes (methods, properties, fields, etc.)
|
||||
var memberAttrs = type.GetMembers(BindingFlags.Public | BindingFlags.NonPublic |
|
||||
BindingFlags.Static | BindingFlags.Instance)
|
||||
.SelectMany(m => m.GetCustomAttributes<ChangelogAttribute>()
|
||||
.Select(attr => (Member: m, Attribute: attr)))
|
||||
.ToList();
|
||||
|
||||
if (typeAttrs.Any() || memberAttrs.Any())
|
||||
{
|
||||
var namespaceName = type.Namespace ?? "Global";
|
||||
var className = type.Name.Split('`')[0];
|
||||
|
||||
// Process type-level attributes
|
||||
foreach (var attr in typeAttrs)
|
||||
{
|
||||
AddEntry(entriesByVersionDate, namespaceName, className, attr.Version, attr.Date,
|
||||
attr.Description);
|
||||
}
|
||||
|
||||
// Process member-level attributes
|
||||
foreach (var (member, attr) in memberAttrs)
|
||||
{
|
||||
var memberName = $"{className}.{member.Name}";
|
||||
AddEntry(entriesByVersionDate, namespaceName, memberName, attr.Version, attr.Date,
|
||||
attr.Description);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (ReflectionTypeLoadException)
|
||||
{
|
||||
// Skip assemblies that can't be fully loaded
|
||||
}
|
||||
}
|
||||
|
||||
foreach (var versionGroup in entriesByVersionDate.OrderByDescending(x => x.Key.Version))
|
||||
{
|
||||
changelog.AppendLine($"## Version {versionGroup.Key.Version}");
|
||||
if (!string.IsNullOrEmpty(versionGroup.Key.Date))
|
||||
{
|
||||
changelog.AppendLine($"### {versionGroup.Key.Date}");
|
||||
}
|
||||
|
||||
changelog.AppendLine();
|
||||
|
||||
foreach (var namespaceGroup in versionGroup.Value.OrderBy(x => x.Key))
|
||||
{
|
||||
changelog.AppendLine($"**{namespaceGroup.Key}**");
|
||||
foreach (var entry in namespaceGroup.Value.OrderBy(x => x.ClassName))
|
||||
{
|
||||
changelog.AppendLine($@"- **{entry.ClassName}**:
|
||||
- {entry.Description}");
|
||||
}
|
||||
|
||||
changelog.AppendLine();
|
||||
}
|
||||
}
|
||||
|
||||
return changelog.ToString();
|
||||
}
|
||||
|
||||
private static void AddEntry(
|
||||
Dictionary<(string Version, string Date), Dictionary<string, List<(string ClassName, string Description)>>>
|
||||
entriesByVersionDate,
|
||||
string namespaceName,
|
||||
string className,
|
||||
string version,
|
||||
string date,
|
||||
string description)
|
||||
{
|
||||
var key = (version, date ?? string.Empty);
|
||||
|
||||
if (!entriesByVersionDate.ContainsKey(key))
|
||||
entriesByVersionDate[key] = new Dictionary<string, List<(string, string)>>();
|
||||
|
||||
if (!entriesByVersionDate[key].ContainsKey(namespaceName))
|
||||
entriesByVersionDate[key][namespaceName] = new List<(string, string)>();
|
||||
|
||||
entriesByVersionDate[key][namespaceName].Add((className, description));
|
||||
}
|
||||
}
|
||||
}
|
||||
Regular → Executable
Regular → Executable
Regular → Executable
+16
-6
@@ -4,28 +4,38 @@
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<ImplicitUsings>disable</ImplicitUsings>
|
||||
<Nullable>enable</Nullable>
|
||||
<Version>1.2.1</Version>
|
||||
<Title>Omega Leo's Helper Library - Changelog</Title>
|
||||
<Authors>Nuno "Omega Leo" Diogo</Authors>
|
||||
<Description>Package to help with Changelog generation</Description>
|
||||
<PackageProjectUrl>https://github.com/omegaleo/HelperLib</PackageProjectUrl>
|
||||
<PackageReadmeFile>README.md</PackageReadmeFile>
|
||||
<RepositoryUrl>https://github.com/omegaleo/HelperLib</RepositoryUrl>
|
||||
<PublishRepositoryUrl>true</PublishRepositoryUrl>
|
||||
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
|
||||
<PackageTags>csharp;dotnet;utility;helper;benchmark</PackageTags>
|
||||
<RepositoryType>git</RepositoryType>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Include="README.md" Pack="true" PackagePath="\"/>
|
||||
<None Include="CHANGELOG.md" Pack="true" PackagePath="\"/>
|
||||
<None Include="LICENSE.md" Pack="true" PackagePath="\"/>
|
||||
<None Include="README.md" Pack="true" PackagePath="\">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Include="CHANGELOG.md" Pack="true" PackagePath="\">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Include="LICENSE.md" Pack="true" PackagePath="\" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<Reference Include="NetFlow.DocumentationHelper.Library">
|
||||
<HintPath>..\..\..\..\..\..\home\omegaleo\.nuget\packages\netflow.documentationhelper.library\1.1.2\lib\netstandard2.1\NetFlow.DocumentationHelper.Library.dll</HintPath>
|
||||
<Reference Include="OmegaLeo.HelperLib.Documentation">
|
||||
<HintPath>..\..\..\..\..\..\home\omegaleo\.nuget\packages\OmegaLeo.HelperLib.Documentation\1.1.2\lib\netstandard2.1\OmegaLeo.HelperLib.Documentation.dll</HintPath>
|
||||
</Reference>
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="NetFlow.DocumentationHelper.Library" Version="1.1.2" />
|
||||
<ProjectReference Include="..\OmegaLeo.HelperLib.Documentation\OmegaLeo.HelperLib.Documentation.csproj" />
|
||||
<ProjectReference Include="..\OmegaLeo.HelperLib.Shared\OmegaLeo.HelperLib.Shared.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
|
||||
Regular → Executable
+1
-1
@@ -3,7 +3,7 @@ Package to help with Changelog generation by providing a new Changelog attribute
|
||||
|
||||
Example attribute usage:
|
||||
```cs
|
||||
[Changelog("v1.0.0", "This is a test")]
|
||||
[Changelog("1.0.0", "This is a test")]
|
||||
[Changelog("v1.0.1", "This is another test")]
|
||||
public class Test
|
||||
{
|
||||
|
||||
Regular → Executable
+2
-3
@@ -2,12 +2,11 @@ using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Text;
|
||||
using NetFlow.DocumentationHelper.Library.Attributes;
|
||||
using OmegaLeo.HelperLib.Changelog.Attributes;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Changelog.Tools
|
||||
{
|
||||
[Changelog("v1.0.0", "Created the class ChangelogTool to extract changelogs via attributes")]
|
||||
[Changelog("1.0.0", "Created the class ChangelogTool to extract changelogs via attributes")]
|
||||
[Documentation("ChangelogTool", "Provides methods to extract changelog information from assembly attributes.")]
|
||||
public class ChangelogTool
|
||||
{
|
||||
|
||||
Regular → Executable
+2
-1
@@ -2,13 +2,14 @@
|
||||
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFramework>net8.0</TargetFramework>
|
||||
<TargetFramework>net9.0</TargetFramework>
|
||||
<ImplicitUsings>disable</ImplicitUsings>
|
||||
<Nullable>enable</Nullable>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\OmegaLeo.HelperLib.Changelog\OmegaLeo.HelperLib.Changelog.csproj" />
|
||||
<ProjectReference Include="..\OmegaLeo.HelperLib.Game\OmegaLeo.HelperLib.Game.csproj" />
|
||||
<ProjectReference Include="..\OmegaLeo.HelperLib\OmegaLeo.HelperLib.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
|
||||
Regular → Executable
+7
-2
@@ -4,7 +4,8 @@ using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Reflection;
|
||||
using GameDevLibrary.Helpers;
|
||||
using OmegaLeo.HelperLib.Changelog.Helpers;
|
||||
using OmegaLeo.HelperLib.Helpers;
|
||||
using OmegaLeo.HelperLib.Changelog.Models;
|
||||
using OmegaLeo.HelperLib.Changelog.Tools;
|
||||
|
||||
@@ -14,6 +15,9 @@ var changelogs = new Dictionary<string, Assembly>()
|
||||
{
|
||||
{Path.Join(root, "OmegaLeo.HelperLib.Changelog", "CHANGELOG.md"), typeof(Changelog).Assembly},
|
||||
{Path.Join(root, "OmegaLeo.HelperLib", "CHANGELOG.md"), typeof(BenchmarkUtility).Assembly},
|
||||
{Path.Join(root, "OmegaLeo.HelperLib.Game", "CHANGELOG.md"), typeof(OmegaLeo.HelperLib.Game.Models.ConsoleCommand).Assembly},
|
||||
{Path.Join(root, "OmegaLeo.HelperLib.Documentation", "CHANGELOG.md"), typeof(OmegaLeo.HelperLib.Documentation.Helpers.DocumentationHelperTool).Assembly},
|
||||
{Path.Join(root, "OmegaLeo.HelperLib.Shared", "CHANGELOG.md"), typeof(OmegaLeo.HelperLib.Shared.Attributes.ChangelogAttribute).Assembly},
|
||||
};
|
||||
|
||||
foreach (var changelog in changelogs)
|
||||
@@ -24,7 +28,8 @@ foreach (var changelog in changelogs)
|
||||
|
||||
void GenerateChangelog(string path, Assembly libraryAssembly)
|
||||
{
|
||||
var changelogMarkdown = ChangelogTool.GetMarkdown(libraryAssembly);
|
||||
var changelogMarkdown = $@"# Changelog
|
||||
{ChangelogHelper.GetChangelogMarkdown(new []{libraryAssembly})}";
|
||||
|
||||
File.WriteAllText(path,changelogMarkdown);
|
||||
}
|
||||
|
||||
Regular → Executable
Regular → Executable
+2
-2
@@ -3,8 +3,8 @@
|
||||
// /media/omegaleo/Development/Library Dev/HelperLib
|
||||
|
||||
using System.Reflection;
|
||||
using GameDevLibrary.Extensions;
|
||||
using GameDevLibrary.Helpers;
|
||||
using OmegaLeo.HelperLib.Extensions;
|
||||
using OmegaLeo.HelperLib.Helpers;
|
||||
using LibGit2Sharp;
|
||||
using OmegaLeo.HelperLib.Changelog.Tools;
|
||||
using OmegaLeo.HelperLib.Git;
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
using OmegaLeo.HelperLib.Changelog.Attributes;
|
||||
|
||||
namespace OmegaLeo.HelperLib.ConsoleApp;
|
||||
|
||||
[Changelog("v1.0.0", "Test")]
|
||||
[Changelog("v1.0.1", "Test 1")]
|
||||
public class TestClass
|
||||
{
|
||||
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
# Changelog
|
||||
## Version 1.2.0
|
||||
### January 26, 2026
|
||||
|
||||
**OmegaLeo.HelperLib.Documentation.Helpers**
|
||||
- **DocumentationHelperTool**:
|
||||
- Migrated DocumentationHelper library from NetFlow.DocumentationHelper.Library to it's own package in OmegaLeo.HelperLib
|
||||
|
||||
@@ -0,0 +1,193 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Xml;
|
||||
using Microsoft.Extensions.DependencyModel;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
using OmegaLeo.HelperLib.Documentation.Models;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Documentation.Helpers
|
||||
{
|
||||
|
||||
[Changelog("1.2.0", "Migrated DocumentationHelper library from NetFlow.DocumentationHelper.Library to it's own package in OmegaLeo.HelperLib", "January 26, 2026")]
|
||||
public static class DocumentationHelperTool
|
||||
{
|
||||
[Documentation("GenerateDocumentation (bool generateForPackageAssembly)",
|
||||
@"Generates a List of objects of type DocumentationStructure that contain the following fields:
|
||||
**AssemblyName**: Name of the main Assembly, used to identify the root namespace
|
||||
**ClassName**: Name of the class, used to identify the upper level object
|
||||
**Title**: Title what we're generating documentation for
|
||||
**Description**: Description of what we're generating documentation for, this can contain usage examples and can use the args array to pass names(e.g.: This method uses this methodology)
|
||||
**Args**: Array of strings that describe the parameters of the method or class
|
||||
**CodeExample**: A code example of how to use the method or class
|
||||
|
||||
*Note: If generateForPackageAssembly is set to true, this will generate documentation for the library as well.*",
|
||||
new []
|
||||
{
|
||||
"generateForPackageAssembly - Generate documentation for the DocumentationHelper library as well?"
|
||||
},
|
||||
@"```csharp
|
||||
DocumentationHelperTool.GenerateDocumentation(true); // Generates documentation for all assemblies including the DocumentationHelper.Library package assembly
|
||||
DocumentationHelperTool.GenerateDocumentation(false); // Generates documentation for all assemblies excluding the DocumentationHelper.Library package assembly
|
||||
```")]
|
||||
public static IEnumerable<DocumentationStructure> GenerateDocumentation(bool generateForPackageAssembly = false)
|
||||
{
|
||||
EnsureReferencedAssembliesLoaded();
|
||||
|
||||
var assemblies = AppDomain.CurrentDomain.GetAssemblies()
|
||||
.Where(a => !a.IsDynamic)
|
||||
.Select(a =>
|
||||
new DocumentationAssembly()
|
||||
{
|
||||
AssemblyName = a.GetName(false)?.Name ?? nameof(a),
|
||||
Types = GetTypesWithDocumentationAttribute(a)
|
||||
}).Where(x => x.Types.Any()).ToList();
|
||||
|
||||
if (!generateForPackageAssembly)
|
||||
{
|
||||
assemblies =
|
||||
assemblies.Where(x => x.AssemblyName != typeof(DocumentationHelperTool).Assembly.GetName().Name)
|
||||
.ToList();
|
||||
}
|
||||
|
||||
foreach (var assembly in assemblies)
|
||||
{
|
||||
foreach (var type in assembly.Types)
|
||||
{
|
||||
var doc = GetDocumentation(type, assembly.AssemblyName);
|
||||
yield return doc;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void EnsureReferencedAssembliesLoaded()
|
||||
{
|
||||
try
|
||||
{
|
||||
var loadedNames = AppDomain.CurrentDomain.GetAssemblies()
|
||||
.Where(a => a.GetName(false) != null)
|
||||
.Select(a => a.GetName(false).Name)
|
||||
.ToHashSet(StringComparer.OrdinalIgnoreCase);
|
||||
|
||||
var deps = DependencyContext.Default?.RuntimeLibraries;
|
||||
if (deps == null) return;
|
||||
|
||||
foreach (var lib in deps)
|
||||
{
|
||||
if (!loadedNames.Contains(lib.Name))
|
||||
{
|
||||
try
|
||||
{
|
||||
Assembly.Load(new AssemblyName(lib.Name));
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Console.Error.WriteLine($"warning OMEGA001: Failed to load assembly '{lib.Name}': {ex.Message}");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
// best-effort only
|
||||
Console.Error.WriteLine($"warning OMEGA001: EnsureReferencedAssembliesLoaded failed: {ex.Message}");
|
||||
}
|
||||
}
|
||||
|
||||
static IEnumerable<Type> GetTypesWithDocumentationAttribute(Assembly assembly)
|
||||
{
|
||||
Type[] types;
|
||||
try
|
||||
{
|
||||
types = assembly.GetTypes();
|
||||
}
|
||||
catch (ReflectionTypeLoadException ex)
|
||||
{
|
||||
types = ex.Types.Where(t => t != null).ToArray();
|
||||
}
|
||||
|
||||
foreach (Type type in types)
|
||||
{
|
||||
if (type == null) continue;
|
||||
|
||||
var classHasDoc = type.GetCustomAttributes(typeof(DocumentationAttribute), true).Any();
|
||||
var fieldsHaveDoc = type.GetFields()
|
||||
.Any(f => f.GetCustomAttributes(typeof(DocumentationAttribute), true).Any());
|
||||
var typesHaveDoc = type.GetProperties()
|
||||
.Any(p => p.GetCustomAttributes(typeof(DocumentationAttribute), true).Any());
|
||||
var methodsHaveDoc = type.GetMethods()
|
||||
.Any(m => m.GetCustomAttributes(typeof(DocumentationAttribute), true).Any());
|
||||
|
||||
if (classHasDoc || fieldsHaveDoc || typesHaveDoc || methodsHaveDoc)
|
||||
{
|
||||
yield return type;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
[Documentation(nameof(GetDocumentation), "Generates a DocumentationStructure object for the given Type and Assembly Name",
|
||||
new []
|
||||
{
|
||||
"type - The Type to generate documentation for",
|
||||
"assemblyName - The name of the assembly the Type belongs to"
|
||||
},
|
||||
@"```csharp
|
||||
var doc = GetDocumentation(typeof(MyClass), ""MyAssembly"");
|
||||
```")]
|
||||
static DocumentationStructure GetDocumentation(Type type, string assemblyName)
|
||||
{
|
||||
var classDocs = type.GetCustomAttributes(typeof(DocumentationAttribute), true)
|
||||
.Select(x => (DocumentationAttribute)x);
|
||||
|
||||
var fieldDocs = type.GetFields().SelectMany(f =>
|
||||
f.GetCustomAttributes(typeof(DocumentationAttribute), true).Select(x => (DocumentationAttribute)x));
|
||||
var propertyDocs = type.GetProperties().SelectMany(p =>
|
||||
p.GetCustomAttributes(typeof(DocumentationAttribute), true).Select(x => (DocumentationAttribute)x));
|
||||
var methodDocs = type.GetMethods().SelectMany(m =>
|
||||
m.GetCustomAttributes(typeof(DocumentationAttribute), true).Select(x => (DocumentationAttribute)x));
|
||||
|
||||
var docStructure = new DocumentationStructure(assemblyName, type.Name);
|
||||
|
||||
foreach (var doc in classDocs)
|
||||
{
|
||||
docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample));
|
||||
}
|
||||
|
||||
foreach (var doc in fieldDocs)
|
||||
{
|
||||
docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample));
|
||||
}
|
||||
|
||||
foreach (var doc in propertyDocs)
|
||||
{
|
||||
docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample));
|
||||
}
|
||||
|
||||
foreach (var doc in methodDocs)
|
||||
{
|
||||
docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample));
|
||||
}
|
||||
|
||||
return docStructure;
|
||||
}
|
||||
|
||||
static Dictionary<string, string> loadedXmlDocumentation =
|
||||
new Dictionary<string, string>();
|
||||
public static void LoadXmlDocumentation(string xmlDocumentation)
|
||||
{
|
||||
using (XmlReader xmlReader = XmlReader.Create(new StringReader(xmlDocumentation)))
|
||||
{
|
||||
while (xmlReader.Read())
|
||||
{
|
||||
if (xmlReader.NodeType == XmlNodeType.Element && xmlReader.Name == "member")
|
||||
{
|
||||
string raw_name = xmlReader["name"];
|
||||
loadedXmlDocumentation[raw_name] = xmlReader.ReadInnerXml();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Documentation.Models
|
||||
{
|
||||
public class DocumentationAssembly
|
||||
{
|
||||
public string AssemblyName;
|
||||
public IEnumerable<Type> Types;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Documentation.Models
|
||||
{
|
||||
|
||||
public class DocumentationStructure
|
||||
{
|
||||
public string AssemblyName;
|
||||
public string ClassName;
|
||||
public List<DocumentationDescription> Descriptions;
|
||||
|
||||
public DocumentationStructure(string assemblyName, string className)
|
||||
{
|
||||
AssemblyName = assemblyName;
|
||||
ClassName = className;
|
||||
Descriptions = new List<DocumentationDescription>();
|
||||
}
|
||||
|
||||
public void AddDescription(DocumentationDescription description)
|
||||
{
|
||||
Descriptions.Add(description);
|
||||
}
|
||||
}
|
||||
|
||||
public class DocumentationDescription
|
||||
{
|
||||
public string Title;
|
||||
public string Description;
|
||||
public string[] Parameters;
|
||||
public string CodeExample = string.Empty;
|
||||
|
||||
[Documentation(nameof(DocumentationDescription), "Description of the current Documented object", new []
|
||||
{
|
||||
"title - Name of the object",
|
||||
"description - Description of what the object does",
|
||||
"parameters - The parameters for the object (in case of a method with parameters)",
|
||||
"codeExample - Code example of how to use the object"
|
||||
})]
|
||||
public DocumentationDescription(string title, string description, string[] parameters = default, string codeExample = "")
|
||||
{
|
||||
Title = title;
|
||||
Description = description;
|
||||
Parameters = parameters ?? Array.Empty<string>();
|
||||
CodeExample = codeExample;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<Nullable>enable</Nullable>
|
||||
<RootNamespace>OmegaLeo.HelperLib.Documentation</RootNamespace>
|
||||
<Version>1.2.1</Version>
|
||||
<Title>Omega Leo's Helper Library</Title>
|
||||
<Authors>Nuno "Omega Leo" Diogo</Authors>
|
||||
<PackageReadmeFile>README.md</PackageReadmeFile>
|
||||
<PackageProjectUrl>https://github.com/omegaleo/HelperLib</PackageProjectUrl>
|
||||
<RepositoryUrl>https://github.com/omegaleo/HelperLib</RepositoryUrl>
|
||||
<PublishRepositoryUrl>true</PublishRepositoryUrl>
|
||||
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
|
||||
<PackageTags>csharp;dotnet;utility;helper;documentation;</PackageTags>
|
||||
<RepositoryType>git</RepositoryType>
|
||||
<GenerateDocumentationFile>true</GenerateDocumentationFile>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.Extensions.DependencyModel" Version="10.0.2" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<Folder Include="Attributes\" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\OmegaLeo.HelperLib.Shared\OmegaLeo.HelperLib.Shared.csproj" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<None Include="README.md" Pack="true" PackagePath="\" />
|
||||
<None Include="CHANGELOG.md" Pack="true" PackagePath="\" />
|
||||
<None Update="README.md">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Update="CHANGELOG.md">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,30 @@
|
||||
# Omega Leo's Helper Library - Documentation
|
||||
Package to help with generating and managing documentation for your C# projects.
|
||||
|
||||
## Features
|
||||
- Attribute-based documentation: Use custom attributes to annotate your classes, methods, and properties with documentation comments.
|
||||
- Documentation extraction tool: A tool to extract and format documentation into various formats (Markdown, HTML, etc.).
|
||||
- Integration with build processes: Easily integrate documentation generation into your CI/CD pipelines.
|
||||
|
||||
## Example attribute usage:
|
||||
```cs
|
||||
[Documentation("GenerateDocumentation (bool generateForPackageAssembly)",
|
||||
@"Generates a List of objects of type DocumentationStructure that contain the following fields:
|
||||
**AssemblyName**: Name of the main Assembly, used to identify the root namespace
|
||||
**ClassName**: Name of the class, used to identify the upper level object
|
||||
**Title**: Title what we're generating documentation for
|
||||
**Description**: Description of what we're generating documentation for, this can contain usage examples and can use the args array to pass names(e.g.: This method uses this methodology)
|
||||
**Args**: Array of strings that describe the parameters of the method or class
|
||||
**CodeExample**: A code example of how to use the method or class
|
||||
|
||||
*Note: If generateForPackageAssembly is set to true, this will generate documentation for the library as well.*",
|
||||
new []
|
||||
{
|
||||
"generateForPackageAssembly - Generate documentation for the DocumentationHelper library as well?"
|
||||
},
|
||||
@"```csharp
|
||||
DocumentationHelperTool.GenerateDocumentation(true); // Generates documentation for all assemblies including the DocumentationHelper.Library package assembly
|
||||
DocumentationHelperTool.GenerateDocumentation(false); // Generates documentation for all assemblies excluding the DocumentationHelper.Library package assembly
|
||||
```")]
|
||||
public static IEnumerable<DocumentationStructure> GenerateDocumentation(bool generateForPackageAssembly = false)
|
||||
```
|
||||
@@ -0,0 +1 @@
|
||||
# Changelog
|
||||
Regular → Executable
+11
@@ -1,10 +1,21 @@
|
||||
using System.Collections.Generic;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
using OmegaLeo.HelperLib.Game.Models;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Game.Extensions
|
||||
{
|
||||
public static class ListExtensions
|
||||
{
|
||||
[Documentation(nameof(Shuffle),
|
||||
"Shuffles the elements of the list in place using the provided RandomNumberGenerator.",
|
||||
null,
|
||||
@"```csharp
|
||||
var list = new List<int> { 1, 2, 3, 4};
|
||||
var rng = new RandomNumberGenerator();
|
||||
// List before: [1, 2, 3, 4]
|
||||
list.Shuffle(rng);
|
||||
// List after: [3, 1, 4, 2] (example output)
|
||||
```")]
|
||||
public static void Shuffle<T>(this IList<T> list, RandomNumberGenerator rng)
|
||||
{
|
||||
for (int i = list.Count - 1; i > 0; i--)
|
||||
|
||||
Regular → Executable
+8
@@ -1,7 +1,12 @@
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
using OmegaLeo.HelperLib.Game.Models;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Game.Handlers
|
||||
{
|
||||
[Documentation(nameof(DelayedActionHandler), "Handler for managing delayed actions, allowing cancellation and status checking.", null, @"```csharp
|
||||
var action = new DelayedAction(...);
|
||||
var handler = new DelayedActionHandler(action);
|
||||
```")]
|
||||
public class DelayedActionHandler
|
||||
{
|
||||
private readonly DelayedAction _action;
|
||||
@@ -11,6 +16,9 @@ namespace OmegaLeo.HelperLib.Game.Handlers
|
||||
_action = action;
|
||||
}
|
||||
|
||||
[Documentation(nameof(Cancel), "Cancels the delayed action if it has not yet executed.", null, @"```csharp
|
||||
handler.Cancel();
|
||||
```")]
|
||||
public void Cancel()
|
||||
{
|
||||
if (_action != null)
|
||||
|
||||
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
+14
-2
@@ -4,11 +4,14 @@
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<Nullable>enable</Nullable>
|
||||
<Title>Omega Leo's Helper Library - Game Logic</Title>
|
||||
<Version>0.0.2</Version>
|
||||
<Version>1.2.1</Version>
|
||||
<Authors>Nuno "Omega Leo" Diogo</Authors>
|
||||
<PackageProjectUrl>https://github.com/omegaleo/HelperLib</PackageProjectUrl>
|
||||
<PackageLicenseUrl>https://github.com/omegaleo/HelperLib/blob/main/LICENSE</PackageLicenseUrl>
|
||||
<RepositoryUrl>https://github.com/omegaleo/HelperLib</RepositoryUrl>
|
||||
<PublishRepositoryUrl>true</PublishRepositoryUrl>
|
||||
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
|
||||
<PackageTags>csharp;dotnet;utility;helper;benchmark</PackageTags>
|
||||
<RepositoryType>git</RepositoryType>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
@@ -19,4 +22,13 @@
|
||||
<PackageReference Include="Newtonsoft.Json" Version="13.0.4" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Update="README.md">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Update="CHANGELOG.md">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
|
||||
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
@@ -1 +0,0 @@
|
||||
# OmegaLeo's Helper Library - Game Logic
|
||||
Executable
+8
@@ -0,0 +1,8 @@
|
||||
# OmegaLeo's Helper Library - Game Logic
|
||||
Lightweight utility library for C# projects and game development helpers.
|
||||
|
||||
## Features
|
||||
- Game development specific helpers and utilities
|
||||
- Helpers for common game development tasks
|
||||
- Easy to integrate into existing projects
|
||||
- Open source under the AGPL v3 License
|
||||
Regular → Executable
+1
-1
@@ -1,7 +1,7 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using NetFlow.DocumentationHelper.Library.Attributes;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
using OmegaLeo.HelperLib.Game.Models;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Game.Services
|
||||
|
||||
Regular → Executable
+1
-1
@@ -1,6 +1,6 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using NetFlow.DocumentationHelper.Library.Attributes;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
using OmegaLeo.HelperLib.Game.Handlers;
|
||||
using OmegaLeo.HelperLib.Game.Models;
|
||||
|
||||
|
||||
Regular → Executable
+1
-1
@@ -1,6 +1,6 @@
|
||||
using System;
|
||||
using System.IO;
|
||||
using NetFlow.DocumentationHelper.Library.Attributes;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
using Newtonsoft.Json;
|
||||
using OmegaLeo.HelperLib.Game.Interfaces;
|
||||
|
||||
|
||||
Regular → Executable
Regular → Executable
Regular → Executable
+1
-1
@@ -1,6 +1,6 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using NetFlow.DocumentationHelper.Library.Attributes;
|
||||
using OmegaLeo.HelperLib.Shared.Attributes;
|
||||
using OmegaLeo.HelperLib.Game.Models;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Game.Utilities
|
||||
|
||||
Regular → Executable
+1
-1
@@ -2,7 +2,7 @@ using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using GameDevLibrary.Extensions;
|
||||
using OmegaLeo.HelperLib.Extensions;
|
||||
using LibGit2Sharp;
|
||||
using OmegaLeo.HelperLib.Git.Models;
|
||||
|
||||
|
||||
Regular → Executable
Regular → Executable
+1
-2
@@ -3,7 +3,7 @@
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<Nullable>enable</Nullable>
|
||||
<RootNamespace>GameDevLibrary.Git</RootNamespace>
|
||||
<RootNamespace>OmegaLeo.HelperLib.Git</RootNamespace>
|
||||
<Version>0.0.2</Version>
|
||||
<Title>Omega Leo's Helper Library - LibGit2Sharp Implementation</Title>
|
||||
<Authors>Nuno "Omega Leo" Diogo</Authors>
|
||||
@@ -13,7 +13,6 @@
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="LibGit2Sharp" Version="0.30.0"/>
|
||||
<PackageReference Include="NetFlow.DocumentationHelper.Library" Version="1.1.2"/>
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
using System;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Shared.Attributes
|
||||
{
|
||||
[Documentation(nameof(ChangelogAttribute), "Attribute to annotate classes, methods, or properties with changelog information.",
|
||||
new []
|
||||
{
|
||||
"Version - Changelog version",
|
||||
"Description - Description of what was changed",
|
||||
"Date - Date of the changes (Optional)"
|
||||
},
|
||||
@"```cs
|
||||
[Changelog(""1.0.0"", ""Created ChangelogAttribute to be used to register changes in the code."")]
|
||||
public class ChangelogAttribute : Attribute" )]
|
||||
[Changelog("1.0.0", "Created ChangelogAttribute to be used to register changes in the code.")]
|
||||
[Changelog("1.2.1", "Created documentation for ChangelogAttribute.", "January 28, 2026")]
|
||||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property, AllowMultiple = true)]
|
||||
public class ChangelogAttribute : Attribute
|
||||
{
|
||||
public string Version { get; }
|
||||
public string Description { get; }
|
||||
|
||||
public string Date { get; set; }
|
||||
|
||||
public ChangelogAttribute(string version, string description, string date = "")
|
||||
{
|
||||
Version = version;
|
||||
Description = description;
|
||||
Date = date;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
using System;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Shared.Attributes
|
||||
{
|
||||
[System.AttributeUsage(AttributeTargets.All, AllowMultiple = false)]
|
||||
[Changelog("1.2.1", "Created documentation for DocumentationAttribute.", "January 28, 2026")]
|
||||
[Documentation("DocumentationAttribute",
|
||||
"Attribute to annotate classes, methods, or properties with documentation information.",
|
||||
new string[]
|
||||
{
|
||||
"title: The title of the documentation.",
|
||||
"description: A brief description.",
|
||||
"args: An array of argument descriptions.",
|
||||
"codeExample: An optional code example."
|
||||
},
|
||||
@"```csharp
|
||||
[Documentation(
|
||||
""MyMethod"",
|
||||
""This method does something important."",
|
||||
new string[] { ""param1: The first parameter."", ""param2: The second parameter."" },
|
||||
""MyMethod(param1, param2);""
|
||||
)]
|
||||
public void MyMethod(string param1, int param2)
|
||||
{
|
||||
// Method implementation
|
||||
}
|
||||
```
|
||||
"
|
||||
)]
|
||||
public class DocumentationAttribute : Attribute
|
||||
{
|
||||
public string Title;
|
||||
public string Description;
|
||||
public string[] Args;
|
||||
public string CodeExample = string.Empty;
|
||||
|
||||
public DocumentationAttribute(string title, string description, string[] args = null, string codeExample = "")
|
||||
{
|
||||
Title = title;
|
||||
Description = description;
|
||||
Args = args ?? Array.Empty<string>();
|
||||
CodeExample = codeExample;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
# Changelog
|
||||
## Version 1.2.1
|
||||
### January 28, 2026
|
||||
|
||||
**OmegaLeo.HelperLib.Shared.Attributes**
|
||||
- **ChangelogAttribute**:
|
||||
- Created documentation for ChangelogAttribute.
|
||||
- **DocumentationAttribute**:
|
||||
- Created documentation for DocumentationAttribute.
|
||||
|
||||
## Version 1.0.0
|
||||
|
||||
**OmegaLeo.HelperLib.Shared.Attributes**
|
||||
- **ChangelogAttribute**:
|
||||
- Created ChangelogAttribute to be used to register changes in the code.
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<Nullable>enable</Nullable>
|
||||
<RootNamespace>OmegaLeo.HelperLib.Shared</RootNamespace>
|
||||
<Version>1.2.1</Version>
|
||||
<Title>Omega Leo's Helper Library - Shared Components</Title>
|
||||
<Authors>Nuno "Omega Leo" Diogo</Authors>
|
||||
<PackageReadmeFile>README.md</PackageReadmeFile>
|
||||
<PackageProjectUrl>https://github.com/omegaleo/HelperLib</PackageProjectUrl>
|
||||
<RepositoryUrl>https://github.com/omegaleo/HelperLib</RepositoryUrl>
|
||||
<PublishRepositoryUrl>true</PublishRepositoryUrl>
|
||||
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
|
||||
<PackageTags>csharp;dotnet;</PackageTags>
|
||||
<RepositoryType>git</RepositoryType>
|
||||
<GenerateDocumentationFile>true</GenerateDocumentationFile>
|
||||
</PropertyGroup>
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>netstandard2.1</TargetFramework>
|
||||
<Nullable>enable</Nullable>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<None Include="README.md" Pack="true" PackagePath="\">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
<None Include="CHANGELOG.md" Pack="true" PackagePath="\">
|
||||
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
|
||||
</None>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -0,0 +1,4 @@
|
||||
# Omega Leo's Helper Library - Shared Components
|
||||
Lightweight utility library for C# projects.
|
||||
|
||||
This library contains shared components and utilities that are used by other packages in the Omega Leo's Helper Library suite.
|
||||
Regular → Executable
+275
-39
@@ -1,9 +1,13 @@
|
||||
// File: `OmegaLeo.HelperLib.Web/Controllers/HomeController.cs`
|
||||
|
||||
using System.Diagnostics;
|
||||
using System.Reflection;
|
||||
using GameDevLibrary.Helpers;
|
||||
using System.Runtime.ExceptionServices;
|
||||
using OmegaLeo.HelperLib.Helpers;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using NetFlow.DocumentationHelper.Library.Helpers;
|
||||
using OmegaLeo.HelperLib.Changelog.Helpers;
|
||||
using OmegaLeo.HelperLib.Documentation.Helpers;
|
||||
using OmegaLeo.HelperLib.Documentation.Models;
|
||||
using OmegaLeo.HelperLib.Changelog.Tools;
|
||||
using OmegaLeo.HelperLib.Web.Models;
|
||||
|
||||
@@ -25,31 +29,49 @@ public class HomeController : Controller
|
||||
if (_libraryCache != null) return;
|
||||
|
||||
var root = GetSolutionRoot();
|
||||
_logger.LogInformation("Initializing libraries from base directory: {Root}", root);
|
||||
|
||||
_libraryCache = new Dictionary<string, LibraryDocumentationViewModel>
|
||||
{
|
||||
["core"] = GenerateLibraryDocs(
|
||||
typeof(BenchmarkUtility).Assembly,
|
||||
Path.Join(root, "OmegaLeo.HelperLib", "CHANGELOG.md"),
|
||||
Path.Combine(root, "changelogs", "OmegaLeo.HelperLib.CHANGELOG.md"),
|
||||
"Core Library",
|
||||
"Core utilities and helper functions for general C# development",
|
||||
"OmegaLeo.HelperLib"
|
||||
),
|
||||
["changelog"] = GenerateLibraryDocs(
|
||||
typeof(Changelog.Models.Changelog).Assembly,
|
||||
Path.Join(root, "OmegaLeo.HelperLib.Changelog", "CHANGELOG.md"),
|
||||
Path.Combine(root, "changelogs", "OmegaLeo.HelperLib.Changelog.CHANGELOG.md"),
|
||||
"Changelog Library",
|
||||
"Tools for managing and generating changelogs",
|
||||
"OmegaLeo.HelperLib.Changelog"
|
||||
),
|
||||
["game"] = GenerateLibraryDocs(
|
||||
typeof(OmegaLeo.HelperLib.Game.Models.ConsoleCommand).Assembly,
|
||||
Path.Join(root, "OmegaLeo.HelperLib.Game", "CHANGELOG.md"),
|
||||
Path.Combine(root, "changelogs", "OmegaLeo.HelperLib.Game.CHANGELOG.md"),
|
||||
"Game Development Library",
|
||||
"Game development utilities for Unity and Godot",
|
||||
"OmegaLeo.HelperLib.Game"
|
||||
)
|
||||
),
|
||||
["documentation"] = GenerateLibraryDocs(
|
||||
typeof(OmegaLeo.HelperLib.Documentation.Helpers.DocumentationHelperTool).Assembly,
|
||||
Path.Combine(root, "changelogs", "OmegaLeo.HelperLib.Documentation.CHANGELOG.md"),
|
||||
"Documentation Library",
|
||||
"Tools for generating documentation from code attributes",
|
||||
"OmegaLeo.HelperLib.Documentation",
|
||||
true
|
||||
),
|
||||
["shared"] = GenerateLibraryDocs(
|
||||
typeof(OmegaLeo.HelperLib.Shared.Attributes.ChangelogAttribute).Assembly,
|
||||
Path.Combine(root, "shared", "OmegaLeo.HelperLib.Shared.CHANGELOG.md"),
|
||||
"Shared Library",
|
||||
"Library of shared attributes and utilities used across other OmegaLeo.HelperLib packages",
|
||||
"OmegaLeo.HelperLib.Shared"
|
||||
),
|
||||
};
|
||||
|
||||
_logger.LogInformation("Initialized {Count} libraries", _libraryCache.Count);
|
||||
}
|
||||
|
||||
public IActionResult Index()
|
||||
@@ -62,7 +84,18 @@ public class HomeController : Controller
|
||||
if (string.IsNullOrEmpty(id) || !_libraryCache.ContainsKey(id))
|
||||
return NotFound();
|
||||
|
||||
return View(_libraryCache[id]);
|
||||
var cache = _libraryCache[id];
|
||||
|
||||
if (cache.Documentation.Any())
|
||||
{
|
||||
_logger.LogInformation($"Found cache for {id}: {cache.Documentation.Count} entries");
|
||||
}
|
||||
else
|
||||
{
|
||||
_logger.LogError($"Cache for {id} is empty!");
|
||||
}
|
||||
|
||||
return View(cache);
|
||||
}
|
||||
|
||||
public IActionResult Privacy()
|
||||
@@ -76,55 +109,258 @@ public class HomeController : Controller
|
||||
return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
|
||||
}
|
||||
|
||||
private LibraryDocumentationViewModel GenerateLibraryDocs(Assembly assembly, string changelogPath, string displayName, string description, string nugetPackageId)
|
||||
private void LogDocumentationHelperInfo()
|
||||
{
|
||||
var allDocumentation = DocumentationHelperTool.GenerateDocumentation();
|
||||
var assemblyName = assembly.GetName().Name;
|
||||
try
|
||||
{
|
||||
var assemblies = AppDomain.CurrentDomain.GetAssemblies();
|
||||
var target = assemblies.FirstOrDefault(a =>
|
||||
a.GetName().Name.Equals("OmegaLeo.HelperLib.Documentation", StringComparison.OrdinalIgnoreCase));
|
||||
|
||||
var filteredDocumentation = allDocumentation
|
||||
.Where(d => d.AssemblyName.Equals(assemblyName, StringComparison.OrdinalIgnoreCase))
|
||||
.OrderBy(d => d.ClassName)
|
||||
.ToList();
|
||||
if (target == null)
|
||||
{
|
||||
_logger.LogWarning("OmegaLeo.HelperLib.Documentation not loaded. Loaded assemblies ({Count}):",
|
||||
assemblies.Length);
|
||||
foreach (var a in assemblies.OrderBy(a => a.GetName().Name))
|
||||
{
|
||||
_logger.LogInformation(" {Name} {Version} => {Location}", a.GetName().Name, a.GetName().Version,
|
||||
SafeLocation(a));
|
||||
}
|
||||
|
||||
string changelogMarkdown = "";
|
||||
return;
|
||||
}
|
||||
|
||||
_logger.LogInformation("Found {Name} {Version} at {Location}", target.GetName().Name,
|
||||
target.GetName().Version, SafeLocation(target));
|
||||
|
||||
Type attrType = null;
|
||||
try
|
||||
{
|
||||
attrType = target.GetType("OmegaLeo.HelperLib.Documentation.Attributes.DocumentationAttribute",
|
||||
false, true);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogWarning(ex, "Failed to GetType for DocumentationAttribute in {Assembly}",
|
||||
target.GetName().Name);
|
||||
}
|
||||
|
||||
if (attrType == null)
|
||||
{
|
||||
_logger.LogWarning("Type 'DocumentationAttribute' not found in {Assembly}.", target.GetName().Name);
|
||||
}
|
||||
else
|
||||
{
|
||||
var ctors = attrType.GetConstructors(BindingFlags.Public | BindingFlags.Instance |
|
||||
BindingFlags.NonPublic);
|
||||
if (!ctors.Any())
|
||||
_logger.LogWarning("No constructors found on DocumentationAttribute in {Assembly}.",
|
||||
target.GetName().Name);
|
||||
foreach (var ctor in ctors)
|
||||
{
|
||||
var sig = string.Join(", ", ctor.GetParameters().Select(p => p.ParameterType.Name + " " + p.Name));
|
||||
_logger.LogInformation("DocumentationAttribute ctor: ({Signature})", sig);
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "Failed to log DocumentationHelper assembly info.");
|
||||
}
|
||||
|
||||
static string SafeLocation(Assembly a)
|
||||
{
|
||||
try
|
||||
{
|
||||
return string.IsNullOrEmpty(a.Location) ? "<in-memory>" : a.Location;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return "<unknown>";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void InspectDocumentationHelperMethod()
|
||||
{
|
||||
try
|
||||
{
|
||||
var assemblies = AppDomain.CurrentDomain.GetAssemblies();
|
||||
Type helperType = null;
|
||||
foreach (var asm in assemblies)
|
||||
{
|
||||
try
|
||||
{
|
||||
var t = asm.GetTypes().FirstOrDefault(tt =>
|
||||
tt.Name.Equals("DocumentationHelperTool", StringComparison.OrdinalIgnoreCase)
|
||||
|| tt.FullName?.EndsWith(".DocumentationHelperTool") == true);
|
||||
if (t != null)
|
||||
{
|
||||
helperType = t;
|
||||
break;
|
||||
}
|
||||
}
|
||||
catch (ReflectionTypeLoadException rtlex)
|
||||
{
|
||||
_logger.LogDebug(rtlex, "Could not enumerate types in {Assembly}", asm.GetName().Name);
|
||||
foreach (var loaderEx in rtlex.LoaderExceptions ?? Array.Empty<Exception>())
|
||||
_logger.LogDebug(loaderEx, "Loader exception for {Assembly}", asm.GetName().Name);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogDebug(ex, "Failed enumerating types in {Assembly}", asm.GetName().Name);
|
||||
}
|
||||
}
|
||||
|
||||
if (helperType == null)
|
||||
{
|
||||
_logger.LogWarning("DocumentationHelperTool type not found in loaded assemblies.");
|
||||
return;
|
||||
}
|
||||
|
||||
_logger.LogInformation("DocumentationHelperTool found: {Type} in {Assembly} ({Location})",
|
||||
helperType.FullName, helperType.Assembly.GetName().Name, SafeLocation(helperType.Assembly));
|
||||
|
||||
var method = helperType.GetMethod("GenerateDocumentation",
|
||||
BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.Instance);
|
||||
if (method == null)
|
||||
{
|
||||
_logger.LogWarning("GenerateDocumentation method not found on {Type}.", helperType.FullName);
|
||||
}
|
||||
else
|
||||
{
|
||||
var parameters = string.Join(", ",
|
||||
method.GetParameters().Select(p => p.ParameterType.Name + " " + p.Name));
|
||||
_logger.LogInformation("Method: {Name} ({Parameters}) -> {ReturnType}", method.Name, parameters,
|
||||
method.ReturnType.FullName);
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "Failed to inspect DocumentationHelperTool type/method.");
|
||||
}
|
||||
|
||||
static string SafeLocation(Assembly a)
|
||||
{
|
||||
try
|
||||
{
|
||||
return string.IsNullOrEmpty(a.Location) ? "<in-memory>" : a.Location;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return "<unknown>";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private LibraryDocumentationViewModel GenerateLibraryDocs(Assembly assembly, string changelogPath,
|
||||
string displayName, string description, string nugetPackageId, bool generateForDocumentationAssembly = false)
|
||||
{
|
||||
_logger.LogInformation("=== Starting GenerateLibraryDocs for {Assembly} ===", assembly.GetName().Name);
|
||||
_logger.LogInformation("Assembly location: {Location}", assembly.Location ?? "<in-memory>");
|
||||
_logger.LogInformation("Changelog path: {Path}", changelogPath);
|
||||
_logger.LogInformation("Changelog exists: {Exists}", System.IO.File.Exists(changelogPath));
|
||||
|
||||
// Log types in assembly and their attributes
|
||||
try
|
||||
{
|
||||
var types = assembly.GetTypes();
|
||||
_logger.LogInformation("Assembly {Name} contains {Count} types", assembly.GetName().Name, types.Length);
|
||||
|
||||
var typesWithDocAttr = types.Where(t =>
|
||||
t.GetCustomAttributes().Any(a =>
|
||||
a.GetType().Name.Contains("Documentation", StringComparison.OrdinalIgnoreCase)))
|
||||
.ToList();
|
||||
|
||||
_logger.LogInformation("Found {Count} types with DocumentationAttribute-like attributes",
|
||||
typesWithDocAttr.Count);
|
||||
|
||||
if (typesWithDocAttr.Any())
|
||||
{
|
||||
foreach (var type in typesWithDocAttr.Take(5))
|
||||
{
|
||||
_logger.LogInformation(" Type with doc attr: {TypeName}", type.FullName);
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "Failed to inspect assembly types");
|
||||
}
|
||||
|
||||
LogDocumentationHelperInfo();
|
||||
|
||||
IEnumerable<DocumentationStructure> allDocumentation = Enumerable.Empty<DocumentationStructure>();
|
||||
try
|
||||
{
|
||||
// Pass the specific assembly to only scan that assembly
|
||||
var result = DocumentationHelperTool.GenerateDocumentation(generateForDocumentationAssembly);
|
||||
allDocumentation = result?
|
||||
.Where(d => d.AssemblyName?.Equals(assembly.GetName().Name ,StringComparison.OrdinalIgnoreCase) == true)
|
||||
.ToList() ?? Enumerable.Empty<DocumentationStructure>();
|
||||
|
||||
_logger.LogInformation("GenerateDocumentation returned {Count} items for {Assembly}",
|
||||
allDocumentation.Count(), assembly.GetName().Name);
|
||||
|
||||
if (!allDocumentation.Any())
|
||||
{
|
||||
_logger.LogWarning(
|
||||
"No documentation items generated for {Assembly}. Check if types have [Documentation] attribute applied.",
|
||||
assembly.GetName().Name);
|
||||
}
|
||||
}
|
||||
catch (MissingMethodException mmex)
|
||||
{
|
||||
_logger.LogError(mmex,
|
||||
"Missing method when calling DocumentationHelperTool.GenerateDocumentation(). Possible assembly mismatch.");
|
||||
InspectDocumentationHelperMethod();
|
||||
ExceptionDispatchInfo.Capture(mmex).Throw();
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "DocumentationHelperTool.GenerateDocumentation threw an exception.");
|
||||
InspectDocumentationHelperMethod();
|
||||
throw;
|
||||
}
|
||||
|
||||
/*var changelogMarkdown = string.Empty;
|
||||
if (System.IO.File.Exists(changelogPath))
|
||||
{
|
||||
changelogMarkdown = ChangelogTool.GetMarkdown(assembly);
|
||||
try
|
||||
{
|
||||
ChangelogTool.ExtractChangelog(assembly);
|
||||
changelogMarkdown = ChangelogTool.GetMarkdown(assembly);
|
||||
_logger.LogInformation("Parsed changelog for {Assembly}", assembly.GetName().Name);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "Failed to parse changelog at {Path}", changelogPath);
|
||||
}
|
||||
}
|
||||
|
||||
string version = assembly.GetCustomAttribute<System.Reflection.AssemblyInformationalVersionAttribute>()?.InformationalVersion
|
||||
?? assembly.GetName().Version?.ToString()
|
||||
?? "1.0.0";
|
||||
|
||||
if (version.Contains('+'))
|
||||
else
|
||||
{
|
||||
version = version.Substring(0, version.IndexOf('+'));
|
||||
}
|
||||
_logger.LogWarning("Changelog file not found at {Path}", changelogPath);
|
||||
}*/
|
||||
|
||||
return new LibraryDocumentationViewModel
|
||||
var viewModel = new LibraryDocumentationViewModel
|
||||
{
|
||||
LibraryName = displayName,
|
||||
Description = description,
|
||||
Version = version,
|
||||
NuGetPackageId = nugetPackageId,
|
||||
Documentation = filteredDocumentation,
|
||||
ChangelogMarkdown = changelogMarkdown
|
||||
ChangelogMarkdown = ChangelogHelper.GetChangelogMarkdown(new []{assembly}),
|
||||
Documentation = allDocumentation.ToList()
|
||||
};
|
||||
|
||||
_logger.LogInformation(
|
||||
"=== Completed GenerateLibraryDocs for {Assembly}. Total documentation items: {Count} ===",
|
||||
assembly.GetName().Name, viewModel.Documentation.Count);
|
||||
|
||||
return viewModel;
|
||||
}
|
||||
|
||||
|
||||
static string GetSolutionRoot()
|
||||
{
|
||||
string dir = AppContext.BaseDirectory;
|
||||
|
||||
while (!string.IsNullOrEmpty(dir))
|
||||
{
|
||||
if (Directory.GetFiles(dir, "*.sln").Length > 0)
|
||||
return dir;
|
||||
|
||||
dir = Directory.GetParent(dir)?.FullName;
|
||||
}
|
||||
|
||||
throw new Exception("Solution root not found.");
|
||||
return AppContext.BaseDirectory;
|
||||
}
|
||||
}
|
||||
|
||||
Regular → Executable
Regular → Executable
+1
-1
@@ -1,5 +1,5 @@
|
||||
// File: `OmegaLeo.HelperLib.Web/Models/LibraryDocumentationViewModel.cs`
|
||||
using NetFlow.DocumentationHelper.Library.Models;
|
||||
using OmegaLeo.HelperLib.Documentation.Models;
|
||||
|
||||
namespace OmegaLeo.HelperLib.Web.Models
|
||||
{
|
||||
|
||||
Regular → Executable
+4
-1
@@ -15,7 +15,10 @@
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Markdig" Version="0.40.0" />
|
||||
<PackageReference Include="NetFlow.DocumentationHelper.Library" Version="1.1.2" />
|
||||
<PackageReference Include="MarkdigExtensions.SyntaxHighlighting" Version="1.0.3" />
|
||||
<PackageReference Include="Serilog.AspNetCore" Version="10.0.0" />
|
||||
<PackageReference Include="Serilog.Sinks.Console" Version="6.1.1" />
|
||||
<PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
|
||||
Regular → Executable
+15
@@ -1,8 +1,23 @@
|
||||
using Serilog;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
// Add services to the container.
|
||||
builder.Services.AddControllersWithViews();
|
||||
|
||||
// Configure logging
|
||||
// Configure Serilog
|
||||
Log.Logger = new LoggerConfiguration()
|
||||
.MinimumLevel.Information()
|
||||
.WriteTo.Console()
|
||||
.WriteTo.File(
|
||||
path: Path.Combine(AppContext.BaseDirectory, "logs", "documentation-.txt"),
|
||||
rollingInterval: RollingInterval.Day,
|
||||
outputTemplate: "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj}{NewLine}{Exception}")
|
||||
.CreateLogger();
|
||||
|
||||
builder.Host.UseSerilog();
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
// Configure the HTTP request pipeline.
|
||||
|
||||
Regular → Executable
Regular → Executable
Regular → Executable
+16
-1
@@ -1,8 +1,16 @@
|
||||
@* File: `OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml` *@
|
||||
@using ColorCode.Styling
|
||||
@using OmegaLeo.HelperLib.Extensions
|
||||
@using Markdig
|
||||
@model OmegaLeo.HelperLib.Web.Models.LibraryDocumentationViewModel
|
||||
@{
|
||||
ViewData["Title"] = Model.LibraryName;
|
||||
var groupedByNamespace = Model.Documentation.GroupBy(d => d.AssemblyName).OrderBy(g => g.Key);
|
||||
|
||||
var pipeline = new MarkdownPipelineBuilder()
|
||||
.UseAdvancedExtensions()
|
||||
.UseSyntaxHighlighting(StyleDictionary.DefaultDark)
|
||||
.Build();
|
||||
}
|
||||
|
||||
<div class="container-fluid mt-4">
|
||||
@@ -75,7 +83,14 @@
|
||||
{
|
||||
<tr>
|
||||
<td><code>@desc.Title</code></td>
|
||||
<td>@Html.Raw(desc.Description)</td>
|
||||
<td>@Html.Raw(Markdig.Markdown.ToHtml(desc.Description))<br/>
|
||||
@if (desc.CodeExample.IsNotNullOrEmpty())
|
||||
{
|
||||
<strong>Example:</strong><br/>
|
||||
<div class="example-code mb-2">
|
||||
@Html.Raw(Markdig.Markdown.ToHtml(desc.CodeExample, pipeline))
|
||||
</div>
|
||||
}</td>
|
||||
</tr>
|
||||
}
|
||||
</tbody>
|
||||
|
||||
Regular → Executable
Regular → Executable
Regular → Executable
+14
-6
@@ -33,6 +33,20 @@
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" asp-area="" asp-controller="Home" asp-action="Library" asp-route-id="game">Game Dev</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" asp-area="" asp-controller="Home" asp-action="Library" asp-route-id="documentation">Documentation</a>
|
||||
</li>
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" asp-area="" asp-controller="Home" asp-action="Library" asp-route-id="shared">Shared Components</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<ul class="navbar-nav ms-auto">
|
||||
<li class="nav-item">
|
||||
<a class="nav-link" href="https://github.com/omegaleo/HelperLib" target="_blank" rel="noopener noreferrer" aria-label="GitHub repository">
|
||||
<i class="bi bi-github" style="font-size:1.25rem;"></i> View on Github
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
@@ -42,12 +56,6 @@
|
||||
@RenderBody()
|
||||
</main>
|
||||
|
||||
<footer class="border-top footer text-muted">
|
||||
<div class="container">
|
||||
© @DateTime.Now.Year - OmegaLeo Helper Libraries
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<script src="~/lib/jquery/dist/jquery.min.js"></script>
|
||||
<script src="~/lib/bootstrap/dist/js/bootstrap.bundle.min.js"></script>
|
||||
<script src="~/js/site.js" asp-append-version="true"></script>
|
||||
|
||||
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
Regular → Executable
+2
-1
@@ -5,5 +5,6 @@
|
||||
"Microsoft.AspNetCore": "Warning"
|
||||
}
|
||||
},
|
||||
"AllowedHosts": "*"
|
||||
"AllowedHosts": "*",
|
||||
"https_port": 443
|
||||
}
|
||||
|
||||
Regular → Executable
+18
@@ -19,4 +19,22 @@ html {
|
||||
|
||||
body {
|
||||
margin-bottom: 60px;
|
||||
}
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
padding: 1rem;
|
||||
background-color: #495057;
|
||||
position: relative;
|
||||
|
||||
color: #f2f2f2;
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: transparent !important;
|
||||
}
|
||||
|
||||
.example-code > div {
|
||||
border-radius: 0.5rem !important;
|
||||
background-color: #495057 !important;
|
||||
}
|
||||
Regular → Executable
|
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
Regular → Executable
Regular → Executable
Vendored
Regular → Executable
Vendored
Regular → Executable
Vendored
Regular → Executable
Vendored
Regular → Executable
Vendored
Regular → Executable
Vendored
Regular → Executable
Vendored
Regular → Executable
Vendored
Regular → Executable
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user