Skip to content

[clang-doc] Add a JSON backend to clang-doc to better leverage mustache templates #140094

Open
@ilovepi

Description

@ilovepi

@petrhosek brought up this idea in #138061.

The general idea is to add a JSON backend to clang-doc, that can be used to verify all the various Info* extraction from the source code (e.g. do we extract the correct data from source files). The JSON backend could essentially become an internal backend that the existing backends (HTML, Markdown, etc.) use in conjunction with mustache templates. That should allow us to remove a significant amount of code from clang-doc, and greatly simplify the implementation.

This would also simplify testing, since the JSON testing would decouple formatting checks via templates from core functionality, and reduce the number of tests we need to maintain.

Metadata

Metadata

Assignees

Labels

clang-dochelp wantedIndicates that a maintainer wants help. Not [good first issue].

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions