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.

Sign up for GitHub

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

Jump to bottom

More Doxygen documentation #408

Merged
merged 52 commits into from
Mar 18, 2024
Merged

More Doxygen documentation #408

merged 52 commits into from
Mar 18, 2024

Conversation

DominykasPetke
Copy link

Added

  • More Doxygen documentation to classes and functions

Changed

  • Minor refactors in LMS7002M and SDRDevice
  • Cleaned up a few type mismatches
  • Renamed a few variables for better clarity
  • Extracted multiple classes into their own files

Removed

  • Some unused code blocks

@DominykasPetke
Finish documenting all the class and structs within classes headers
3685a9c
@DominykasPetke
Separate PCIe classes into separate files
4a6f907
@DominykasPetke
Document a few functions
0cc5e94
@DominykasPetke
Split TRXLooper_PCIE classes out into their own files and document Av…
1371c1b 
…gRmsCounter
@DominykasPetke
Document USB Generic
b5cc9e2
@DominykasPetke
Clean up Device REgistry and Handle documentation
568a223
@DominykasPetke
Document DeltaVariable
288567d
@DominykasPetke
Add SlaveSelectShim documentation
84e9477
@DominykasPetke
Add USB Pipe and USBTransferContext documentation
93fec50
@DominykasPetke
Merge branch 'litepcie-update' into litepcie-update-more-doxygen
fe70473
@DominykasPetke
Add missing command into the documentation generation documentation
74d0f38
@DominykasPetke
Finish documenting all the connection classes
3724d62
@DominykasPetke
Clean up extraneous return type documentation
791f6a7
@DominykasPetke
Document and clean up SamplesPacket and PacketsFIFO
a38eb87
@DominykasPetke
Remove unused channel parameter from LMS7002M::Get/SetClockFreq
e430441
@DominykasPetke
Document and slightly refactor SDRDevice
da38b43
@DominykasPetke
Document all the main device classes
eba9cf9
@DominykasPetke
Fix PacketsFIFO documentation, document MemoryPool and WriteRegisters…
4e34515 
…Batch
@DominykasPetke
Make StreamRx/Tx return type be uint32_t everywhere.
0b09e53
@DominykasPetke
Document TRXLooper
dd6871f
@DominykasPetke
Document StreamComposite
8460857
@DominykasPetke
Separate WriteRegistersBatch into their own files
5c530a4
@DominykasPetke
Clean up SetInterfaceFreq defintions
aea60ae
@DominykasPetke
Document a few more FPGA functions
fd94f1c
@DominykasPetke
Clean up a small mistake in LMS7002M::GetGFIRCoefficients docs
c8667ab
@DominykasPetke
Merge branch 'litepcie-update' into litepcie-update-more-doxygen
f5dde8d
@DominykasPetke
Clean up misdocumented parameters warnings
1771fe1
@DominykasPetke
Add full documentation coverage of SDRDevice
fa7f6fd
@DominykasPetke
Document and slightly refactor LMS7002M's methods.
ff23ae1
@DominykasPetke
Document all the variables in the public includes folder
b734f2f
@DominykasPetke
Merge branch 'litepcie-update' into litepcie-update-more-doxygen
0eed3af
@DominykasPetke
OpStatus documentation fixes
a7f1a93
@DominykasPetke
Minor fixups
b5d22f8
@DominykasPetke
clang-format
2249901
@DominykasPetke
Fix Windows compile errors
cf1ae17
@DominykasPetke
Merge branch 'litepcie-update' into litepcie-update-more-doxygen
865366a
@DominykasPetke
clang-format
b364c01
@DominykasPetke
Fix Windows compile
6819411
@DominykasPetke
Add documentation for the freshly added changes
b7d9df8
@DominykasPetke
Merge branch 'litepcie-update' into litepcie-update-more-doxygen
53f8c27
@DominykasPetke
Fix (mis)documentations
bf7e993
@DominykasPetke
Add missing extern C comment
519defb
@DominykasPetke
Fix unnecessary // clang-format off
ff56554
@DominykasPetke
Document undocumented parameters in otherwise documented functions
5980b60
@DominykasPetke
Fix a broken function
053dd0c
@DominykasPetke
Fix undocumented return values on otherwise documented functions
e892d29
@DominykasPetke
Fix minor typo
9ef418a
@DominykasPetke
Merge branch 'litepcie-update' into litepcie-update-more-doxygen
a8ccf5f
rjonaitis
rjonaitis requested changes Mar 14, 2024
View reviewed changes
Copy link
Member

@rjonaitis rjonaitis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future try making smaller PRs. This huge PR contains not only documentation changes, but also code functionality modifications, which could be overlooked among the many changes.

src/ADF4002/ADF4002.cpp Outdated Show resolved Hide resolved
src/FPGA_common/FPGA_common.cpp Show resolved Hide resolved
src/FPGA_common/FPGA_common.cpp Outdated Show resolved Hide resolved
src/FPGA_common/FPGA_common.cpp Outdated Show resolved Hide resolved
src/FPGA_common/FPGA_common.cpp Outdated Show resolved Hide resolved
src/boards/LimeSDR_X3/LimeSDR_X3.cpp Outdated Show resolved Hide resolved
src/protocols/SamplesPacket.h Outdated Show resolved Hide resolved
src/protocols/TRXLooper.cpp Outdated Show resolved Hide resolved
src/protocols/TRXLooper.cpp Outdated Show resolved Hide resolved
src/lms7002m/LMS7002M.cpp Outdated Show resolved Hide resolved
@rjonaitis rjonaitis merged commit 2b6f326 into myriadrf:litepcie-update Mar 18, 2024
5 checks passed
@DominykasPetke DominykasPetke deleted the litepcie-update-more-doxygen branch March 18, 2024 11:28
DominykasPetke pushed a commit to Matom-ai/LimeSuite that referenced this pull request Mar 28, 2024
@rjonaitis
Merge pull request myriadrf#408 from Matom-ai/litepcie-update-more-do…
7907023 
…xygen

More Doxygen documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rjonaitis rjonaitis rjonaitis requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@DominykasPetke @rjonaitis