Skip to content

Complete API documentation for MPFitLib public surface#41

Open
anders9ustafsson with Copilot wants to merge 2 commits into
GH-40from
copilot/gh-40-finalize-api-documentation
Open

Complete API documentation for MPFitLib public surface#41
anders9ustafsson with Copilot wants to merge 2 commits into
GH-40from
copilot/gh-40-finalize-api-documentation

Conversation

Copilot AI commented Mar 26, 2026

Copy link
Copy Markdown

Two documentation gaps remained in the GH-40 branch: mp_par.cs had no XML doc comments at all, and both Solve overloads in MPFit.cs had an empty <param name="config"> tag.

Changes

  • mp_par.cs — Replaced all /* */ inline comments with XML /// documentation, consistent with the rest of the public API:

    • <list type="bullet"> for the side field's five valid values
    • <remarks> + <see cref="side"/> cross-reference on deriv_debug
    • <see langword="null"/> on the nullable parname field
  • MPFit.cs — Filled the empty config param doc on both Solve(mp_func, ...) and Solve(mp_func_ref, ...) overloads:

/// <param name="config">
/// pointer to structure which specifies the configuration of MPFit.Solve; or
/// <see langword="null"/> if the default configuration is to be used.
/// See <see cref="mp_config"/> for definition and use of config.
/// </param>

Copilot AI and others added 2 commits March 26, 2026 15:31
Agent-Logs-Url: https://github.com/cureos/csmpfit/sessions/3b2ec056-1513-471d-a538-e42df6d31005

Co-authored-by: anders9ustafsson <6515030+anders9ustafsson@users.noreply.github.com>
Agent-Logs-Url: https://github.com/cureos/csmpfit/sessions/0364cf05-51d0-4958-a5fe-dea11a58ed65

Co-authored-by: anders9ustafsson <6515030+anders9ustafsson@users.noreply.github.com>
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.

2 participants