Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(src): add examples alias and general cleanup #2763

Merged

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Jun 26, 2024

Description

  • Add @examples and @examples_end aliases.
  • Move some documentation blocks to the declarations instead of the definitions.
  • Remove unused parameters from cli args, such as --version.
  • Document all enums (poorly) and force any new enums to be documented.
  • Remove type from return descriptions, as it's redundant.

Screenshot

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

  • I want maintainers to keep my branch updated

@ReenigneArcher ReenigneArcher force-pushed the docs(src)-add-examples-alias-and-general-cleanup branch from d2c7437 to 941ead9 Compare June 26, 2024 19:52
Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 42.85714% with 8 lines in your changes missing coverage. Please review.

Project coverage is 8.99%. Comparing base (13f94f1) to head (d02e1a7).
Report is 144 commits behind head on master.

Files with missing lines Patch % Lines
src/entry_handler.cpp 0.00% 4 Missing ⚠️
src/process.cpp 20.00% 2 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##           master   #2763      +/-   ##
=========================================
+ Coverage    8.96%   8.99%   +0.02%     
=========================================
  Files          94      94              
  Lines       17392   17383       -9     
  Branches     8270    8267       -3     
=========================================
+ Hits         1560    1564       +4     
+ Misses      12963   12962       -1     
+ Partials     2869    2857      -12     
Flag Coverage Δ
Linux 6.85% <0.00%> (+0.06%) ⬆️
Windows 4.16% <0.00%> (ø)
macOS-12 10.01% <46.15%> (-0.04%) ⬇️
macOS-13 9.92% <46.15%> (-0.04%) ⬇️
macOS-14 10.22% <46.15%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/audio.cpp 28.57% <ø> (ø)
src/audio.h 0.00% <ø> (ø)
src/cbs.cpp 7.75% <ø> (ø)
src/cbs.h 33.33% <ø> (ø)
src/config.cpp 4.77% <ø> (ø)
src/config.h 0.00% <ø> (ø)
src/confighttp.cpp 1.16% <ø> (+0.38%) ⬆️
src/crypto.cpp 0.81% <ø> (ø)
src/crypto.h 0.00% <ø> (ø)
src/file_handler.cpp 84.00% <ø> (ø)
... and 84 more

@ReenigneArcher ReenigneArcher force-pushed the docs(src)-add-examples-alias-and-general-cleanup branch 15 times, most recently from 13d0868 to 1fc020d Compare June 27, 2024 19:53
@ReenigneArcher ReenigneArcher marked this pull request as ready for review June 27, 2024 19:54
@ReenigneArcher ReenigneArcher force-pushed the docs(src)-add-examples-alias-and-general-cleanup branch from 1fc020d to d02e1a7 Compare June 27, 2024 20:51
@ReenigneArcher ReenigneArcher merged commit 1dd4b68 into master Jun 28, 2024
49 checks passed
@ReenigneArcher ReenigneArcher deleted the docs(src)-add-examples-alias-and-general-cleanup branch June 28, 2024 12:34
ReenigneArcher added a commit to Hazer/Sunshine that referenced this pull request Jun 28, 2024
ReenigneArcher added a commit to Hazer/Sunshine that referenced this pull request Jun 28, 2024
ReenigneArcher added a commit to Hazer/Sunshine that referenced this pull request Jun 28, 2024
Hazer pushed a commit to Hazer/Sunshine that referenced this pull request Jul 2, 2024
Hazer pushed a commit to Hazer/Sunshine that referenced this pull request Jul 4, 2024
Hazer added a commit to Hazer/Sunshine that referenced this pull request Jul 14, 2024
chore: fix weird imports

chore: fix sys tray import error

chore: fix clang code style

refactor: mouse, keyboard and touch now on their own namespaces

fix: make platf_input a singleton

refactor: better isolation

lint: remove import and space

lint: import order

docs: refactor docs too

lint: new line at the end

build: glob linking input/server

build: full src glob

chore: rebase fixes

chore: revert doc changes

docs(src): apply new patterns from LizardByte#2763

chore: fixes from code review
Hazer added a commit to Hazer/Sunshine that referenced this pull request Jul 14, 2024
chore: fix weird imports

chore: fix sys tray import error

chore: fix clang code style

refactor: mouse, keyboard and touch now on their own namespaces

fix: make platf_input a singleton

refactor: better isolation

lint: remove import and space

lint: import order

docs: refactor docs too

lint: new line at the end

build: glob linking input/server

build: full src glob

chore: rebase fixes

chore: revert doc changes

docs(src): apply new patterns from LizardByte#2763

chore: fixes from code review
Hazer added a commit to Hazer/Sunshine that referenced this pull request Aug 6, 2024
chore: fix weird imports

chore: fix sys tray import error

chore: fix clang code style

refactor: mouse, keyboard and touch now on their own namespaces

fix: make platf_input a singleton

refactor: better isolation

lint: remove import and space

lint: import order

docs: refactor docs too

lint: new line at the end

build: glob linking input/server

build: full src glob

chore: rebase fixes

chore: revert doc changes

docs(src): apply new patterns from LizardByte#2763

chore: fixes from code review
Hazer added a commit to Hazer/Sunshine that referenced this pull request Aug 8, 2024
chore: fix weird imports

chore: fix sys tray import error

chore: fix clang code style

refactor: mouse, keyboard and touch now on their own namespaces

fix: make platf_input a singleton

refactor: better isolation

lint: remove import and space

lint: import order

docs: refactor docs too

lint: new line at the end

build: glob linking input/server

build: full src glob

chore: rebase fixes

chore: revert doc changes

docs(src): apply new patterns from LizardByte#2763

chore: fixes from code review
Hazer added a commit to Hazer/Sunshine that referenced this pull request Aug 11, 2024
chore: fix weird imports

chore: fix sys tray import error

chore: fix clang code style

refactor: mouse, keyboard and touch now on their own namespaces

fix: make platf_input a singleton

refactor: better isolation

lint: remove import and space

lint: import order

docs: refactor docs too

lint: new line at the end

build: glob linking input/server

build: full src glob

chore: rebase fixes

chore: revert doc changes

docs(src): apply new patterns from LizardByte#2763

chore: fixes from code review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant