API Reference

This section contains auto-generated API documentation from XML doc comments in the source code.

Coverage Status

Current XML doc comment coverage is approximately 33%. Areas with gaps will show minimal documentation.

Project Coverage Notes
DBTools.Core ~22% Needs improvement
DBTools.App ~37% Moderate
DBTools.Themes ~1% Critical gap
SGT ~50% Best documented
GM ~23% Large codebase

Improving Coverage

To improve API documentation:

  1. Add /// XML doc comments to public members
  2. Include at minimum: <summary>, <param>, <returns>
  3. Run docfx build to regenerate

Example:

/// <summary>
/// Executes a transaction with the specified action.
/// </summary>
/// <param name="action">The action to execute within the transaction.</param>
/// <returns>True if the transaction succeeded; otherwise, false.</returns>
/// <exception cref="InvalidOperationException">Thrown when no document is active.</exception>
public bool Execute(Action action)
{
    // ...
}

Namespaces

Once API metadata is generated via docfx metadata, namespace links will appear here:

  • DBTools.Core
  • DBTools.App
  • DBTools.Themes
  • DBTools.GM
  • DBTools.SGT

Note: Run docfx docfx.json (not docfx-conceptual.json) to generate API documentation from XML comments.

Edit this page