[clang-doc] Make --repository change the HTML output by ilovepi · Pull Request #122566 · llvm/llvm-project (original) (raw)

@llvm/pr-subscribers-clang-tools-extra

Author: Paul Kirth (ilovepi)

Changes

The current check in writeFileDefinition() is incorrect, and prevents us
from ever emitting the URL from the clang-doc tool. The unit tests do
test this, but call the API directly circumventing the check.

This is the first step towards addressing #59814.

Full diff: https://github.com/llvm/llvm-project/pull/122566.diff

4 Files Affected:

• (modified) clang-tools-extra/clang-doc/HTMLGenerator.cpp (+1-1)
• (modified) clang-tools-extra/test/clang-doc/Inputs/basic-project/src/Circle.cpp (+2-1)
• (modified) clang-tools-extra/test/clang-doc/basic-project.test (+174-121)
• (modified) clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp (+6-1)

diff --git a/clang-tools-extra/clang-doc/HTMLGenerator.cpp b/clang-tools-extra/clang-doc/HTMLGenerator.cpp index e3532559a32fcc..a400d2e9cbd184 100644 --- a/clang-tools-extra/clang-doc/HTMLGenerator.cpp +++ b/clang-tools-extra/clang-doc/HTMLGenerator.cpp @@ -494,7 +494,7 @@ genReferencesBlock(const std::vector &References, static std::unique_ptr writeFileDefinition(const Location &L, std::optional RepositoryUrl = std::nullopt) {

• if (!L.IsFileInRootDir || !RepositoryUrl)

• if (!L.IsFileInRootDir && !RepositoryUrl) return std::make_unique( HTMLTag::TAG_P, "Defined at line " + std::to_string(L.LineNumber) + " of file " + L.Filename);

diff --git a/clang-tools-extra/test/clang-doc/Inputs/basic-project/src/Circle.cpp b/clang-tools-extra/test/clang-doc/Inputs/basic-project/src/Circle.cpp index 823384a4d97e86..3ddb2fd9ff563e 100644 --- a/clang-tools-extra/test/clang-doc/Inputs/basic-project/src/Circle.cpp +++ b/clang-tools-extra/test/clang-doc/Inputs/basic-project/src/Circle.cpp @@ -8,4 +8,5 @@ double Circle::area() const {

double Circle::perimeter() const { return 3.141 * radius_; -} \ No newline at end of file +} + diff --git a/clang-tools-extra/test/clang-doc/basic-project.test b/clang-tools-extra/test/clang-doc/basic-project.test index b6b43bb82bb15d..1f5ba8bdc0703d 100644 --- a/clang-tools-extra/test/clang-doc/basic-project.test +++ b/clang-tools-extra/test/clang-doc/basic-project.test @@ -54,130 +54,183 @@ // JSON-INDEX-NEXT: }; // JSON-INDEX-NEXT: }

-// HTML-SHAPE:

class Shape

Defined at line 8 of file {{.}}Shape.h

Abstract base class for shapes.

Provides a common interface for different types of shapes.

Functions

area

public double area()

Calculates the area of the shape.

perimeter

public double perimeter()

Calculates the perimeter of the shape.

double The perimeter of the shape.

~Shape

public void ~Shape()

Defined at line 13 of file {{.}}Shape.h

Virtual destructor.

class Shape

+// HTML-SHAPE-NEXT: Defined at line +// HTML-SHAPE-NEXT: 8 +// HTML-SHAPE-NEXT: of file +// HTML-SHAPE-NEXT: Shape.h +// HTML-SHAPE-NEXT:

Abstract base class for shapes.

Provides a common interface for different types of shapes.

Functions

area

public double area()

Calculates the area of the shape.

perimeter

public double perimeter()

Calculates the perimeter of the shape.

double The perimeter of the shape.

~Shape

public void ~Shape()

Virtual destructor.

-// HTML-CALC:

class Calculator

Defined at line 8 of file {{.}}Calculator.h

A simple calculator class.

Provides basic arithmetic operations.

Functions

add

public int add(int a, int b)

Defined at line 3 of file {{.}}Calculator.cpp

Adds two integers.

int The sum of a and b.

subtract

public int subtract(int a, int b)

Defined at line 7 of file {{.}}Calculator.cpp

Subtracts the second integer from the first.

int The result of a - b.

multiply

public int multiply(int a, int b)

Defined at line 11 of file {{.}}Calculator.cpp

Multiplies two integers.

int The product of a and b.

divide

public double divide(int a, int b)

Defined at line 15 of file {{.*}}Calculator.cpp

Divides the first integer by the second.

double The result of a / b.

if b is zero.

class Calculator

+// HTML-CALC-NEXT: Defined at line +// HTML-CALC-NEXT: 8 +// HTML-CALC-NEXT: of file +// HTML-CALC-NEXT: Calculator.h +// HTML-CALC-NEXT:

A simple calculator class.

Provides basic arithmetic operations.

Functions

add

public int add(int a, int b)

Adds two integers.

int The sum of a and b.

subtract

public int subtract(int a, int b)

Subtracts the second integer from the first.

int The result of a - b.

multiply

public int multiply(int a, int b)

Multiplies two integers.

int The product of a and b.

divide

public double divide(int a, int b)

Divides the first integer by the second.

double The result of a / b.

if b is zero.

-// HTML-RECTANGLE:

class Rectangle

Defined at line 10 of file {{.}}Rectangle.h

Represents a rectangle with a given width and height.</p -// HTML-RECTANGLE:

-// HTML-RECTANGLE: Inherits from -// HTML-RECTANGLE: Shape -// HTML-RECTANGLE:

Members

Width of the rectangle.

Height of the rectangle.

Functions

Rectangle

public void Rectangle(double width, double height)

Defined at line 3 of file {{.}}Rectangle.cpp

Constructs a new Rectangle object.

area

public double area()

Defined at line 6 of file {{.}}Rectangle.cpp

Calculates the area of the rectangle.

double The area of the rectangle.

perimeter

public double perimeter()

Defined at line 10 of file {{.}}Rectangle.cpp

Calculates the perimeter of the rectangle.

double The perimeter of the rectangle.

class Rectangle

+// HTML-RECTANGLE-NEXT: Defined at line +// HTML-RECTANGLE-NEXT: 10 +// HTML-RECTANGLE-NEXT: of file +// HTML-RECTANGLE-NEXT: Rectangle.h +// HTML-RECTANGLE-NEXT:

Represents a rectangle with a given width and height.

+// HTML-RECTANGLE: Inherits from +// HTML-RECTANGLE: Shape +// HTML-RECTANGLE:

Members

Width of the rectangle.

Height of the rectangle.

Functions

Rectangle

public void Rectangle(double width, double height)

Constructs a new Rectangle object.

area

public double area()

Calculates the area of the rectangle.

double The area of the rectangle.

perimeter

public double perimeter()

Calculates the perimeter of the rectangle.

double The perimeter of the rectangle.

-// HTML-CIRCLE:

class Circle

Defined at line 10 of file {{.}}Circle.h

Circle class derived from Shape.

Represents a circle with a given radius.

-// HTML-CIRCLE: Inherits from -// HTML-CIRCLE: Shape -// HTML-CIRCLE:

Members

Radius of the circle.

Functions

Circle

public void Circle(double radius)

Defined at line 3 of file {{.}}Circle.cpp

Constructs a new Circle object.

area

public double area()

Defined at line 5 of file {{.}}Circle.cpp

Calculates the area of the circle.

double The area of the circle.

perimeter

public double perimeter()

Defined at line 9 of file {{.}}Circle.cpp

Calculates the perimeter of the circle.

double The perimeter of the circle.

class Circle

+// HTML-CIRCLE-NEXT: Defined at line +// HTML-CIRCLE-NEXT: 10 +// HTML-CIRCLE-NEXT: of file +// HTML-CIRCLE-NEXT: Circle.h +// HTML-CIRCLE-NEXT:

Circle class derived from Shape.

Represents a circle with a given radius.

+// HTML-CIRCLE: Inherits from +// HTML-CIRCLE: Shape +// HTML-CIRCLE:

Members

Radius of the circle.

Functions

Circle

public void Circle(double radius)

Constructs a new Circle object.

area

public double area()

Calculates the area of the circle.

double The area of the circle.

perimeter

public double perimeter()

Calculates the perimeter of the circle.

double The perimeter of the circle.

// MD-CALC: # class Calculator // MD-CALC: Defined at .{{[/]}}include{{[/]}}Calculator.h#8 diff --git a/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp b/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp index dfd31e65787145..97afa12cab6d32 100644 --- a/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp +++ b/clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp @@ -319,7 +319,12 @@ TEST(HTMLGeneratorTest, emitFunctionHTML) { int P)

• Defined at line 10 of file dir/test.cpp

•  Defined at line 

•  <a href="https://www.repository.com/dir/test.cpp#10">10</a>

•   of file 

•  <a href="https://www.repository.com/dir/test.cpp">test.cpp</a>