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: document code with doxygen, breathe, and sphinx_csharp #187

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Dec 16, 2023

Description

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

Copy link

codecov bot commented Dec 16, 2023

Codecov Report

Merging #187 (6c696d6) into master (172e61d) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #187   +/-   ##
=======================================
  Coverage   47.80%   47.80%           
=======================================
  Files           4        4           
  Lines         228      228           
  Branches       16       16           
=======================================
  Hits          109      109           
  Misses        115      115           
  Partials        4        4           
Files Coverage Δ
Jellyfin.Plugin.Themerr/Api/ThemerrController.cs 0.00% <ø> (ø)

@ReenigneArcher ReenigneArcher force-pushed the docs-document-code-with-doxygen-breathe-and-sphinx_csharp branch 2 times, most recently from ef707b8 to 5597755 Compare December 16, 2023 20:50
@ReenigneArcher ReenigneArcher force-pushed the docs-document-code-with-doxygen-breathe-and-sphinx_csharp branch 4 times, most recently from 02eadc3 to 1c1a97f Compare December 17, 2023 04:46
@ReenigneArcher ReenigneArcher marked this pull request as ready for review December 17, 2023 04:47
@ReenigneArcher ReenigneArcher force-pushed the docs-document-code-with-doxygen-breathe-and-sphinx_csharp branch 3 times, most recently from 1151148 to 018c5a8 Compare December 17, 2023 05:04
@ReenigneArcher ReenigneArcher force-pushed the docs-document-code-with-doxygen-breathe-and-sphinx_csharp branch from 018c5a8 to 6c696d6 Compare December 17, 2023 05:10
@ReenigneArcher ReenigneArcher merged commit 238c2c6 into master Dec 17, 2023
17 checks passed
@ReenigneArcher ReenigneArcher deleted the docs-document-code-with-doxygen-breathe-and-sphinx_csharp branch December 17, 2023 13:56
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.

None yet

1 participant