Enhance type signatures with direct base classes and interfaces

.cspell.yaml

@@ -24,12 +24,17 @@ words:
   - fileassert
   - frontmatter
   - GHDL
+  - hrefs
   - isysroot
   - isystem
   - libc
   - libclang
   - libclangsharp
   - libext
+  - linkified
+  - Linkification
+  - Linkify
+  - linkify
   - misattributed
   - msbuild
   - MSBuild

README.md

@@ -1,10 +1,17 @@
 # ApiMark
 
-[![Build](https://github.com/DemaConsulting/ApiMark/actions/workflows/build_on_push.yaml/badge.svg)](https://github.com/DemaConsulting/ApiMark/actions/workflows/build_on_push.yaml)
-
 <!-- IMPORTANT: All links in this file must be absolute URLs.
      This file is distributed in packages and relative links will not resolve. -->
 
+[![GitHub forks](https://img.shields.io/github/forks/demaconsulting/ApiMark?style=plastic)](https://github.com/demaconsulting/ApiMark/network/members)
+[![GitHub stars](https://img.shields.io/github/stars/demaconsulting/ApiMark?style=plastic)](https://github.com/demaconsulting/ApiMark/stargazers)
+[![GitHub contributors](https://img.shields.io/github/contributors/demaconsulting/ApiMark?style=plastic)](https://github.com/demaconsulting/ApiMark/graphs/contributors)
+[![License](https://img.shields.io/github/license/demaconsulting/ApiMark?style=plastic)](https://github.com/demaconsulting/ApiMark/blob/main/LICENSE)
+[![Build](https://img.shields.io/github/actions/workflow/status/demaconsulting/ApiMark/build_on_push.yaml)](https://github.com/demaconsulting/ApiMark/actions/workflows/build_on_push.yaml)
+[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=demaconsulting_ApiMark&metric=alert_status)](https://sonarcloud.io/dashboard?id=demaconsulting_ApiMark)
+[![Security](https://sonarcloud.io/api/project_badges/measure?project=demaconsulting_ApiMark&metric=security_rating)](https://sonarcloud.io/dashboard?id=demaconsulting_ApiMark)
+[![NuGet](https://img.shields.io/nuget/v/DemaConsulting.ApiMark.MSBuild?style=plastic)](https://www.nuget.org/packages/DemaConsulting.ApiMark.MSBuild)
+
 ## Overview
 
 ApiMark generates compact, AI-friendly API reference documentation in Markdown
@@ -15,21 +22,23 @@ 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
+- 📄 **Compact Markdown Output** - AI-friendly API reference from source code
+- 🔍 **Gradual Disclosure** - Index → namespace → type → member detail
+- 🔷 **C#/.NET Support** - Mono.Cecil + XML documentation comments
+- ➕ **C++ Support** - `clang -ast-dump=json` + Doxygen-style comments
+- 🔧 **MSBuild Integration** - Auto-documents `.csproj` and `.vcxproj` builds
+- 🖥️ **CLI Tool** - `apimark` dotnet tool covering all languages
+- 🤖 **AI-Optimized** - Minimal noise, explicit navigation links
+- 🌐 **Multi-Platform** - Windows, Linux, and macOS on .NET 8, 9, and 10
+- ✅ **Self-Validation** - Built-in qualification tests for regulated environments
 
 ## Platform Support
 
 | Platform | .NET | C++ |
 | --- | --- | --- |
-| Windows x64 | ✅ | ✅ |
-| Linux x64 | ✅ | ✅ |
-| macOS (Apple Silicon) | ✅ | ✅ |
+| Windows | ✅ | ✅ |
+| Linux | ✅ | ✅ |
+| macOS | ✅ | ✅ |
 
 ## Prerequisites
 
@@ -97,8 +106,16 @@ ApiMark generates documentation automatically after every build.
 # 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
+# Generate API documentation from C++ public headers (document all headers under include/)
 apimark cpp --includes include/ --output docs/api
+
+# Document only specific headers using --api-headers patterns (gitignore-style, ordered)
+apimark cpp \
+  --includes include/ \
+  --api-headers "include/**" \
+  --api-headers "!include/detail/**" \
+  --api-headers "include/detail/public_api.h" \
+  --output docs/api
 ```
 
 Run `apimark --help` for all options. Run `apimark dotnet --help` or `apimark cpp --help` for language-specific options.

docs/design/api-mark-cpp.md

@@ -49,8 +49,10 @@ ApiMarkCore.
   compiler flags, then parses the JSON output into structured C++ AST records.
 - *Contract*: `clang -Xclang -ast-dump=json -fparse-all-comments -fsyntax-only
   -x c++ -std={standard} -I {roots} -isystem {sysroots} -D {defines} {headers}`.
-  The clang executable is located automatically (PATH, xcrun on macOS, vswhere on
-  Windows) or from `CppGeneratorOptions.ClangPath`.
+  The clang executable is located using this priority order:
+  (1) `CppGeneratorOptions.ClangPath` when set;
+  (2) the `APIMARK_CLANG_PATH` environment variable when set;
+  (3) `clang` on PATH; (4) `xcrun clang` on macOS; (5) vswhere / default LLVM path on Windows.
 - *Constraints*: clang must be installed and accessible; a clear
   `InvalidOperationException` is thrown when clang cannot be found.
 
@@ -79,14 +81,16 @@ N/A — not a safety-classified software item.
 ## Data Flow
 
 1. The caller (ApiMarkTool) constructs `CppGeneratorOptions` with
-   PublicIncludeRoots, IncludePatterns, ExcludePatterns, SystemIncludePaths,
-   AdditionalIncludePaths, Defines, CppStandard, AdditionalCompilerArguments,
+   PublicIncludeRoots, ApiHeaderPatterns, SystemIncludePaths,
+   Defines, CppStandard, AdditionalCompilerArguments,
    Visibility, IncludeDeprecated, and LibraryName, then passes an
    IMarkdownWriterFactory to Generate.
-2. CppGenerator enumerates all header files under each PublicIncludeRoot,
-   applying IncludePatterns and ExcludePatterns, to produce the candidate file
-   set. Each matched header is parsed as an independent translation unit so that
-   headers are self-contained.
+2. CppGenerator enumerates all header files under each PublicIncludeRoot.
+   When ApiHeaderPatterns is non-empty, patterns are applied with gitignore-style
+   last-match-wins semantics to produce the candidate file set; when empty, all
+   recognized header files under every root are included automatically. Each
+   matched header is parsed as an independent translation unit so that headers
+   are self-contained.
 3. CppGenerator calls `ClangAstParser.Parse` with all candidate headers and the
    configured options. `ClangAstParser` invokes `clang -ast-dump=json` and parses
    the resulting JSON into `CppCompilationResult` containing `CppNamespaceDecl`
@@ -96,9 +100,8 @@ N/A — not a safety-classified software item.
    physically located in the public headers, already filtered by ownership.
 5. CppGenerator applies the IsOwnedDeclaration filter to each declaration:
    only declarations whose source file normalizes to a path under a
-   PublicIncludeRoot, matches IncludePatterns, and does not match
-   ExcludePatterns are documented. System and third-party declarations are
-   used for type resolution only.
+   PublicIncludeRoot that was selected by ApiHeaderPatterns are documented.
+   System and third-party declarations are used for type resolution only.
 6. For each owned declaration, CppGenerator derives the canonical #include path
    as the source file path relative to its matching PublicIncludeRoot, expressed
    with forward slashes.