llvm / llvm/llvm-project

[clang-doc] Have a description for the JSON format

Open
#171,697 0 comments 0 reactions 0 assignees View on GitHub
clang-doc documentation
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

There should be a document somewhere describing the possible format of the JSON output. This would help as a reference when adding new constructs to HTML or to future formats that use JSON. Right now, you have to look inside `JSONGenerator.cpp` to check whether something is an object or what the properties of an object are. That makes it difficult to easily add placeholders to templates.

Contributor guide

Open the contributing guide

Research direction

Start by reading JSONGenerator.cpp, which the issue identifies as the current source of information about the JSON output. Document whether each output element is an object and list its properties so the format can serve as a reference for adding template placeholders and future JSON-based formats.

Written by the indexing model from the issue text.

Assessment

Domain
compilers, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.