DemaConsulting.ApiMark.MSBuild 0.2.0

ApiMark

Overview

ApiMark generates compact, AI-friendly API reference documentation in Markdown from source code and associated metadata (XML doc comments, header files, docstrings, etc.). The output is designed for gradual disclosure: an AI can read a lightweight index, drill into a namespace summary, and then read a full type page — consuming only as much context as the task requires.

Features

• Generates compact Markdown API reference from source code and doc comments
• Gradual disclosure output: root index → namespace summary → type page → member detail
• C#/.NET support via Mono.Cecil and XML documentation comments
• C++ support via clang -ast-dump=json and Doxygen-style doc comments
• MSBuild task integration for .csproj and .vcxproj-based builds
• dotnet tool CLI (apimark) covering all supported languages
• Designed for AI consumption — minimal noise, explicit navigation links between levels

Platform Support

Prerequisites

C++ Support

C++ documentation generation requires clang to be installed and available:

• Windows: Install LLVM or the "C++ Clang tools for Windows" component via the Visual Studio Installer. The ClangPath MSBuild property or --clang-path CLI option can point to a specific installation.
• macOS: Xcode Command Line Tools (xcode-select --install) — clang is included.
• Linux: Install via the system package manager (e.g. apt install clang or dnf install clang).

.NET support has no additional prerequisites beyond the .NET SDK.

Installation

CLI Tool

dotnet tool install --global DemaConsulting.ApiMark.Tool

MSBuild Integration

C# projects — add the NuGet package to your .csproj:

<ItemGroup>
  <PackageReference Include="DemaConsulting.ApiMark.MSBuild" Version="x.y.z" />
</ItemGroup>

Enable XML documentation generation so ApiMark can read doc comments:

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

C++ projects — add the NuGet package to your .vcxproj:

<ItemGroup>
  <PackageReference Include="DemaConsulting.ApiMark.MSBuild" Version="x.y.z" />
</ItemGroup>

Set the public include root so ApiMark knows which headers to document:

<PropertyGroup>
  <ApiMarkIncludePaths>$(MSBuildProjectDirectory)\include</ApiMarkIncludePaths>
</PropertyGroup>

ApiMark generates documentation automatically after every build.

Usage

CLI Usage

# Generate API documentation from a .NET assembly
apimark dotnet --assembly MyProject.dll --xml-doc MyProject.xml --output docs/api

# Generate API documentation from C++ public headers
apimark cpp --includes include/ --output docs/api

Run apimark --help for all options. Run apimark dotnet --help or apimark cpp --help for language-specific options.

MSBuild Usage

Documentation is generated automatically after every build. Output goes to $(MSBuildProjectDirectory)\api by default. Configure with MSBuild properties:

<PropertyGroup>
  
  <ApiMarkOutputDir>$(MSBuildProjectDirectory)\docs\api</ApiMarkOutputDir>

  
  <ApiMarkVisibility>PublicAndProtected</ApiMarkVisibility>

  
  <ApiMarkPackDocs>true</ApiMarkPackDocs>

  
  <DisableApiMark>true</DisableApiMark>
</PropertyGroup>

See the User Guide for the full list of properties including C++-specific options.

Building

pwsh ./build.ps1

User Guide

The ApiMark User Guide is available on the ApiMark releases page.

Contributing

See CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License — see LICENSE.

Support

• Report a bug or request a feature
• Ask a question or start a discussion