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

Commits on Dec 19, 2023

  1. Finish documenting all the class and structs within classes headers

    @DominykasPetke
    DominykasPetke committed Dec 19, 2023
    Configuration menu
    Copy the full SHA
    3685a9c View commit details
    Browse the repository at this point in the history

  2. Separate PCIe classes into separate files

    @DominykasPetke
    DominykasPetke committed Dec 19, 2023
    Configuration menu
    Copy the full SHA
    4a6f907 View commit details
    Browse the repository at this point in the history

  3. Document a few functions

    @DominykasPetke
    DominykasPetke committed Dec 19, 2023
    Configuration menu
    Copy the full SHA
    0cc5e94 View commit details
    Browse the repository at this point in the history

Commits on Dec 20, 2023

  1. Split TRXLooper_PCIE classes out into their own files and document Av… 

    …gRmsCounter
    @DominykasPetke
    DominykasPetke committed Dec 20, 2023
    Configuration menu
    Copy the full SHA
    1371c1b View commit details
    Browse the repository at this point in the history

  2. Document USB Generic

    @DominykasPetke
    DominykasPetke committed Dec 20, 2023
    Configuration menu
    Copy the full SHA
    b5cc9e2 View commit details
    Browse the repository at this point in the history

  3. Clean up Device REgistry and Handle documentation

    @DominykasPetke
    DominykasPetke committed Dec 20, 2023
    Configuration menu
    Copy the full SHA
    568a223 View commit details
    Browse the repository at this point in the history

  4. Document DeltaVariable

    @DominykasPetke
    DominykasPetke committed Dec 20, 2023
    Configuration menu
    Copy the full SHA
    288567d View commit details
    Browse the repository at this point in the history

Commits on Dec 21, 2023

  1. Add SlaveSelectShim documentation

    @DominykasPetke
    DominykasPetke committed Dec 21, 2023
    Configuration menu
    Copy the full SHA
    84e9477 View commit details
    Browse the repository at this point in the history

  2. Add USB Pipe and USBTransferContext documentation

    @DominykasPetke
    DominykasPetke committed Dec 21, 2023
    Configuration menu
    Copy the full SHA
    93fec50 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'litepcie-update' into litepcie-update-more-doxygen

    @DominykasPetke
    DominykasPetke committed Dec 21, 2023
    Configuration menu
    Copy the full SHA
    fe70473 View commit details
    Browse the repository at this point in the history

  4. Add missing command into the documentation generation documentation

    @DominykasPetke
    DominykasPetke committed Dec 21, 2023
    Configuration menu
    Copy the full SHA
    74d0f38 View commit details
    Browse the repository at this point in the history

  5. Finish documenting all the connection classes

    @DominykasPetke
    DominykasPetke committed Dec 21, 2023
    Configuration menu
    Copy the full SHA
    3724d62 View commit details
    Browse the repository at this point in the history

  6. Clean up extraneous return type documentation

    @DominykasPetke
    DominykasPetke committed Dec 21, 2023
    Configuration menu
    Copy the full SHA
    791f6a7 View commit details
    Browse the repository at this point in the history

Commits on Dec 22, 2023

  1. Document and clean up SamplesPacket and PacketsFIFO

    @DominykasPetke
    DominykasPetke committed Dec 22, 2023
    Configuration menu
    Copy the full SHA
    a38eb87 View commit details
    Browse the repository at this point in the history

  2. Remove unused channel parameter from LMS7002M::Get/SetClockFreq

    @DominykasPetke
    DominykasPetke committed Dec 22, 2023
    Configuration menu
    Copy the full SHA
    e430441 View commit details
    Browse the repository at this point in the history

  3. Document and slightly refactor SDRDevice

    @DominykasPetke
    DominykasPetke committed Dec 22, 2023
    Configuration menu
    Copy the full SHA
    da38b43 View commit details
    Browse the repository at this point in the history

  4. Document all the main device classes

    @DominykasPetke
    DominykasPetke committed Dec 22, 2023
    Configuration menu
    Copy the full SHA
    eba9cf9 View commit details
    Browse the repository at this point in the history

  5. Fix PacketsFIFO documentation, document MemoryPool and WriteRegisters… 

    …Batch
    @DominykasPetke
    DominykasPetke committed Dec 22, 2023
    Configuration menu
    Copy the full SHA
    4e34515 View commit details
    Browse the repository at this point in the history

Commits on Dec 27, 2023

  1. Make StreamRx/Tx return type be uint32_t everywhere.

    @DominykasPetke
    DominykasPetke committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    0b09e53 View commit details
    Browse the repository at this point in the history

  2. Document TRXLooper

    @DominykasPetke
    DominykasPetke committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    dd6871f View commit details
    Browse the repository at this point in the history

  3. Document StreamComposite

    @DominykasPetke
    DominykasPetke committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    8460857 View commit details
    Browse the repository at this point in the history

  4. Separate WriteRegistersBatch into their own files

    @DominykasPetke
    DominykasPetke committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    5c530a4 View commit details
    Browse the repository at this point in the history

  5. Clean up SetInterfaceFreq defintions

    @DominykasPetke
    DominykasPetke committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    aea60ae View commit details
    Browse the repository at this point in the history

  6. Document a few more FPGA functions

    @DominykasPetke
    DominykasPetke committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    fd94f1c View commit details
    Browse the repository at this point in the history

Commits on Jan 2, 2024

  1. Clean up a small mistake in LMS7002M::GetGFIRCoefficients docs

    @DominykasPetke
    DominykasPetke committed Jan 2, 2024
    Configuration menu
    Copy the full SHA
    c8667ab View commit details
    Browse the repository at this point in the history

Commits on Feb 6, 2024

  1. Merge branch 'litepcie-update' into litepcie-update-more-doxygen

    @DominykasPetke
    DominykasPetke committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    f5dde8d View commit details
    Browse the repository at this point in the history

  2. Clean up misdocumented parameters warnings

    @DominykasPetke
    DominykasPetke committed Feb 6, 2024
    Configuration menu
    Copy the full SHA
    1771fe1 View commit details
    Browse the repository at this point in the history

Commits on Feb 7, 2024

  1. Add full documentation coverage of SDRDevice

    @DominykasPetke
    DominykasPetke committed Feb 7, 2024
    Configuration menu
    Copy the full SHA
    fa7f6fd View commit details
    Browse the repository at this point in the history

Commits on Feb 8, 2024

  1. Document and slightly refactor LMS7002M's methods.

    @DominykasPetke
    DominykasPetke committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    ff23ae1 View commit details
    Browse the repository at this point in the history

  2. Document all the variables in the public includes folder

    @DominykasPetke
    DominykasPetke committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    b734f2f View commit details
    Browse the repository at this point in the history

Commits on Feb 20, 2024

  1. Merge branch 'litepcie-update' into litepcie-update-more-doxygen

    @DominykasPetke
    DominykasPetke committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    0eed3af View commit details
    Browse the repository at this point in the history

  2. OpStatus documentation fixes

    @DominykasPetke
    DominykasPetke committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    a7f1a93 View commit details
    Browse the repository at this point in the history

  3. Minor fixups

    @DominykasPetke
    DominykasPetke committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    b5d22f8 View commit details
    Browse the repository at this point in the history

  4. clang-format

    @DominykasPetke
    DominykasPetke committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    2249901 View commit details
    Browse the repository at this point in the history

  5. Fix Windows compile errors

    @DominykasPetke
    DominykasPetke committed Feb 20, 2024
    Configuration menu
    Copy the full SHA
    cf1ae17 View commit details
    Browse the repository at this point in the history

Commits on Feb 26, 2024

  1. Merge branch 'litepcie-update' into litepcie-update-more-doxygen

    @DominykasPetke
    DominykasPetke committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    865366a View commit details
    Browse the repository at this point in the history

  2. clang-format

    @DominykasPetke
    DominykasPetke committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    b364c01 View commit details
    Browse the repository at this point in the history

  3. Fix Windows compile

    @DominykasPetke
    DominykasPetke committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    6819411 View commit details
    Browse the repository at this point in the history

  4. Add documentation for the freshly added changes

    @DominykasPetke
    DominykasPetke committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    b7d9df8 View commit details
    Browse the repository at this point in the history

Commits on Mar 5, 2024

  1. Merge branch 'litepcie-update' into litepcie-update-more-doxygen

    @DominykasPetke
    DominykasPetke committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    53f8c27 View commit details
    Browse the repository at this point in the history

  2. Fix (mis)documentations

    @DominykasPetke
    DominykasPetke committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    bf7e993 View commit details
    Browse the repository at this point in the history

  3. Add missing extern C comment

    @DominykasPetke
    DominykasPetke committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    519defb View commit details
    Browse the repository at this point in the history

  4. Fix unnecessary // clang-format off

    @DominykasPetke
    DominykasPetke committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    ff56554 View commit details
    Browse the repository at this point in the history

  5. Document undocumented parameters in otherwise documented functions

    @DominykasPetke
    DominykasPetke committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    5980b60 View commit details
    Browse the repository at this point in the history

Commits on Mar 7, 2024

  1. Fix a broken function

    @DominykasPetke
    DominykasPetke committed Mar 7, 2024
    Configuration menu
    Copy the full SHA
    053dd0c View commit details
    Browse the repository at this point in the history

  2. Fix undocumented return values on otherwise documented functions

    @DominykasPetke
    DominykasPetke committed Mar 7, 2024
    Configuration menu
    Copy the full SHA
    e892d29 View commit details
    Browse the repository at this point in the history

Commits on Mar 8, 2024

  1. Fix minor typo

    @DominykasPetke
    DominykasPetke committed Mar 8, 2024
    Configuration menu
    Copy the full SHA
    9ef418a View commit details
    Browse the repository at this point in the history

Commits on Mar 12, 2024

  1. Merge branch 'litepcie-update' into litepcie-update-more-doxygen

    @DominykasPetke
    DominykasPetke committed Mar 12, 2024
    Configuration menu
    Copy the full SHA
    a8ccf5f View commit details
    Browse the repository at this point in the history

Commits on Mar 14, 2024

  1. Fix misdocumentation

    @DominykasPetke
    DominykasPetke committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    57750a1 View commit details
    Browse the repository at this point in the history

  2. Extract IntToChannel to a function

    @DominykasPetke
    DominykasPetke committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    41c252f View commit details
    Browse the repository at this point in the history

  3. Fix FPGA functionality changes

    @DominykasPetke
    DominykasPetke committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    ad9eefe View commit details
    Browse the repository at this point in the history

  4. Decouple SamplesPacket from SDRDevice

    @DominykasPetke
    DominykasPetke committed Mar 14, 2024
    Configuration menu
    Copy the full SHA
    e0b3ed5 View commit details
    Browse the repository at this point in the history