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: use doxygen directly and drop breathe #2739

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Jun 21, 2024

Description

Breathe does no support Objective-C and I am tired of fighting it. This PR will use Doxygen for source code documentation instead of Breathe. While it may not be as pretty, it will be sufficient.

Also, Windows builds will revert to installed boost instead of fetched to improve build times. The codeql build was especially slow.

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-use-doxygen-directly-and-drop-breathe branch 4 times, most recently from e792c28 to a205598 Compare June 21, 2024 04:06
Copy link

codecov bot commented Jun 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 8.96%. Comparing base (13f94f1) to head (e56a7c9).
Report is 1 commits behind head on master.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #2739   +/-   ##
======================================
  Coverage    8.96%   8.96%           
======================================
  Files          94      94           
  Lines       17392   17392           
  Branches     8270    8270           
======================================
  Hits         1560    1560           
- Misses      12963   12967    +4     
+ Partials     2869    2865    -4     
Flag Coverage Δ
Linux 6.79% <ø> (ø)
Windows 4.16% <ø> (ø)
macOS-12 10.04% <ø> (-0.02%) ⬇️
macOS-13 9.95% <ø> (ø)
macOS-14 10.24% <ø> (ø)

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

see 3 files with indirect coverage changes

@ReenigneArcher ReenigneArcher force-pushed the docs-use-doxygen-directly-and-drop-breathe branch 15 times, most recently from 996ce32 to e96d9a9 Compare June 24, 2024 21:05
@ReenigneArcher ReenigneArcher force-pushed the docs-use-doxygen-directly-and-drop-breathe branch from e96d9a9 to e56a7c9 Compare June 24, 2024 21:34
@ReenigneArcher ReenigneArcher marked this pull request as ready for review June 24, 2024 21:38
@ReenigneArcher ReenigneArcher enabled auto-merge (squash) June 24, 2024 21:41
@ReenigneArcher ReenigneArcher merged commit 10666c0 into master Jun 24, 2024
49 checks passed
@ReenigneArcher ReenigneArcher deleted the docs-use-doxygen-directly-and-drop-breathe branch June 24, 2024 22:14
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