Skip to content

[clang-doc] Enable MD tests in basic-project #131924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 19, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions clang-tools-extra/test/clang-doc/basic-project.test
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// RUN: rm -rf %t && mkdir -p %t/docs %t/build
// RUN: sed 's|$test_dir|%/S|g' %S/Inputs/basic-project/database_template.json > %t/build/compile_commands.json

// RUN: clang-doc --format=html --output=%t/docs --executor=all-TUs %t/build/compile_commands.json
// RUN: FileCheck %s -input-file=%t/docs/index_json.js -check-prefix=JSON-INDEX
// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Shape.html -check-prefixes=HTML-SHAPE,SHAPE-NO-REPOSITORY
Expand All @@ -14,6 +15,13 @@
// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Rectangle.html -check-prefixes=HTML-RECTANGLE,RECTANGLE-REPOSITORY
// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Circle.html -check-prefixes=HTML-CIRCLE,CIRCLE-REPOSITORY

// RUN: clang-doc --format=md --output=%t/docs --executor=all-TUs %t/build/compile_commands.json
// RUN: FileCheck %s -input-file=%t/docs/all_files.md -check-prefixes=MD-ALL-FILES
// RUN: FileCheck %s -input-file=%t/docs/index.md -check-prefixes=MD-INDEX
// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Shape.md -check-prefixes=MD-SHAPE
// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Calculator.md -check-prefixes=MD-CALC
// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Rectangle.md -check-prefixes=MD-RECTANGLE
// RUN: FileCheck %s -input-file=%t/docs/GlobalNamespace/Circle.md -check-prefixes=MD-CIRCLE

// JSON-INDEX: async function LoadIndex() {
// JSON-INDEX-NEXT: return{
Expand Down Expand Up @@ -358,10 +366,6 @@
// MD-SHAPE: **brief** Abstract base class for shapes.
// MD-SHAPE: Provides a common interface for different types of shapes.
// MD-SHAPE: ## Functions
// MD-SHAPE: ### ~Shape
// MD-SHAPE: *public void ~Shape()*
// MD-SHAPE: *Defined at .{{[\/]}}include{{[\/]}}Shape.h#13*
// MD-SHAPE: **brief** Virtual destructor.
// MD-SHAPE: ### area
// MD-SHAPE: *public double area()*
// MD-SHAPE: **brief** Calculates the area of the shape.
Expand All @@ -370,6 +374,10 @@
// MD-SHAPE: *public double perimeter()*
// MD-SHAPE: **brief** Calculates the perimeter of the shape.
// MD-SHAPE: **return** double The perimeter of the shape.
// MD-SHAPE: ### ~Shape
// MD-SHAPE: *public void ~Shape()*
// MD-SHAPE: *Defined at .{{[\/]}}include{{[\/]}}Shape.h#13*
// MD-SHAPE: **brief** Virtual destructor.

// MD-ALL-FILES: # All Files
// MD-ALL-FILES: ## [GlobalNamespace](GlobalNamespace{{[\/]}}index.md)
Expand Down