CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
362 lines
13 KiB
C++
362 lines
13 KiB
C++
// RUN: rm -rf %t && mkdir -p %t
|
|
// RUN: clang-doc --pretty-json --output=%t --format=html --executor=standalone %s
|
|
// RUN: FileCheck %s < %t/json/GlobalNamespace/_ZTV7MyClass.json
|
|
// RUN: FileCheck %s < %t/html/GlobalNamespace/_ZTV7MyClass.html -check-prefix=HTML
|
|
|
|
/// This is a struct friend.
|
|
struct Foo;
|
|
|
|
// This is a nice class.
|
|
// It has some nice methods and fields.
|
|
// @brief This is a brief description.
|
|
struct MyClass {
|
|
int PublicField;
|
|
|
|
int myMethod(int MyParam);
|
|
static void staticMethod();
|
|
const int& getConst();
|
|
|
|
enum Color {
|
|
RED,
|
|
GREEN,
|
|
BLUE = 5
|
|
};
|
|
|
|
typedef int MyTypedef;
|
|
|
|
class NestedClass;
|
|
|
|
friend struct Foo;
|
|
/// This is a function template friend.
|
|
template<typename T> friend void friendFunction(int);
|
|
protected:
|
|
int protectedMethod();
|
|
|
|
int ProtectedField;
|
|
private:
|
|
int PrivateField;
|
|
};
|
|
|
|
// CHECK: {
|
|
// CHECK-NEXT: "Contexts": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "DocumentationFileName": "index",
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "Name": "Global Namespace",
|
|
// CHECK-NEXT: "QualName": "GlobalNamespace",
|
|
// CHECK-NEXT: "RelativePath": "./",
|
|
// CHECK-NEXT: "USR": "0000000000000000000000000000000000000000"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "Description": {
|
|
// CHECK-NEXT: "BriefComments": [
|
|
// CHECK-NEXT: [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "TextComment": "This is a brief description."
|
|
// CHECK: "HasBriefComments": true,
|
|
// CHECK-NEXT: "HasParagraphComments": true,
|
|
// CHECK-NEXT: "ParagraphComments": [
|
|
// CHECK-NEXT: [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "TextComment": "This is a nice class."
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "TextComment": "It has some nice methods and fields."
|
|
// CHECK-NEXT: }
|
|
// CHECK: "DocumentationFileName": "_ZTV7MyClass",
|
|
// CHECK: "Enums": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "InfoType": "enum",
|
|
// CHECK-NEXT: "Location": {
|
|
// CHECK-NEXT: "Filename": "{{.*}}class.cpp",
|
|
// CHECK-NEXT: "LineNumber": 19
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "Members": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "Name": "RED",
|
|
// CHECK-NEXT: "Value": "0"
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "Name": "GREEN",
|
|
// CHECK-NEXT: "Value": "1"
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "Name": "BLUE",
|
|
// CHECK-NEXT: "ValueExpr": "5"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "Name": "Color",
|
|
// CHECK-NEXT: "Namespace": [
|
|
// CHECK-NEXT: "MyClass",
|
|
// CHECK-NEXT: "GlobalNamespace"
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "Scoped": false,
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "Friends": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "Description": {
|
|
// CHECK-NEXT: "HasParagraphComments": true,
|
|
// CHECK-NEXT: "ParagraphComments": [
|
|
// CHECK-NEXT: [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "TextComment": "This is a function template friend."
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ]
|
|
// CHECK-NEXT: ]
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "InfoType": "friend",
|
|
// CHECK-NEXT: "IsClass": false,
|
|
// CHECK-NEXT: "Params": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "Name": "",
|
|
// CHECK-NEXT: "Type": {
|
|
// CHECK-NEXT: "Name": "int",
|
|
// CHECK-NEXT: "QualName": "int",
|
|
// CHECK-NEXT: "USR": "0000000000000000000000000000000000000000"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "Reference": {
|
|
// CHECK-NEXT: "Name": "friendFunction",
|
|
// CHECK-NEXT: "QualName": "friendFunction",
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "ReturnType": {
|
|
// CHECK-NEXT: "IsBuiltIn": true,
|
|
// CHECK-NEXT: "IsTemplate": false,
|
|
// CHECK-NEXT: "Name": "void",
|
|
// CHECK-NEXT: "QualName": "void",
|
|
// CHECK-NEXT: "USR": "0000000000000000000000000000000000000000"
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "Template": {
|
|
// CHECK-NEXT: "Parameters": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "Param": "typename T"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "VerticalDisplay": false
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "Description": {
|
|
// CHECK-NEXT: "HasParagraphComments": true,
|
|
// CHECK-NEXT: "ParagraphComments": [
|
|
// CHECK-NEXT: [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "TextComment": "This is a struct friend."
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ]
|
|
// CHECK-NEXT: ]
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "InfoType": "friend",
|
|
// CHECK-NEXT: "IsClass": true,
|
|
// CHECK-NEXT: "Reference": {
|
|
// CHECK-NEXT: "Name": "Foo",
|
|
// CHECK-NEXT: "Path": "GlobalNamespace",
|
|
// CHECK-NEXT: "QualName": "Foo",
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "HasContexts": true,
|
|
// CHECK-NEXT: "HasEnums": true,
|
|
// CHECK-NEXT: "HasFriends": true,
|
|
// CHECK-NEXT: "HasMembers": true,
|
|
// CHECK-NEXT: "HasPrivateMembers": true,
|
|
// CHECK-NEXT: "HasProtectedMembers": true,
|
|
// CHECK-NEXT: "HasProtectedMethods": true,
|
|
// CHECK-NEXT: "HasPublicMembers": true,
|
|
// CHECK-NEXT: "HasPublicMethods": true,
|
|
// CHECK-NEXT: "HasRecords": true,
|
|
// CHECK-NEXT: "HasTypedefs": true,
|
|
// CHECK-NEXT: "InfoType": "record",
|
|
// CHECK-NEXT: "IsTypedef": false,
|
|
// CHECK-NEXT: "Location": {
|
|
// CHECK-NEXT: "Filename": "{{.*}}class.cpp",
|
|
// CHECK-NEXT: "LineNumber": 12
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "MangledName": "_ZTV7MyClass",
|
|
// CHECK-NEXT: "Name": "MyClass",
|
|
// CHECK-NEXT: "Namespace": [
|
|
// CHECK-NEXT: "GlobalNamespace"
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "Path": "GlobalNamespace",
|
|
// CHECK-NEXT: "PrivateMembers": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "IsStatic": false,
|
|
// CHECK-NEXT: "Name": "PrivateField",
|
|
// CHECK-NEXT: "Type": "int"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "ProtectedMembers": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "IsStatic": false,
|
|
// CHECK-NEXT: "Name": "ProtectedField",
|
|
// CHECK-NEXT: "Type": "int"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "ProtectedMethods": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "InfoType": "function",
|
|
// CHECK-NEXT: "IsStatic": false,
|
|
// CHECK-NEXT: "Name": "protectedMethod",
|
|
// CHECK-NEXT: "Namespace": [
|
|
// CHECK-NEXT: "MyClass",
|
|
// CHECK-NEXT: "GlobalNamespace"
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "ReturnType": {
|
|
// CHECK-NEXT: "IsBuiltIn": true,
|
|
// CHECK-NEXT: "IsTemplate": false,
|
|
// CHECK-NEXT: "Name": "int",
|
|
// CHECK-NEXT: "QualName": "int",
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK: "PublicMembers": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "IsStatic": false,
|
|
// CHECK-NEXT: "Name": "PublicField",
|
|
// CHECK-NEXT: "Type": "int"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "PublicMethods": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "InfoType": "function",
|
|
// CHECK-NEXT: "IsStatic": false,
|
|
// CHECK-NEXT: "Name": "myMethod",
|
|
// CHECK-NEXT: "Namespace": [
|
|
// CHECK-NEXT: "MyClass",
|
|
// CHECK-NEXT: "GlobalNamespace"
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "Params": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "Name": "MyParam",
|
|
// CHECK-NEXT: "ParamEnd": true,
|
|
// CHECK-NEXT: "Type": {
|
|
// CHECK-NEXT: "Name": "int",
|
|
// CHECK-NEXT: "QualName": "int",
|
|
// CHECK-NEXT: "USR": "0000000000000000000000000000000000000000"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "ReturnType": {
|
|
// CHECK-NEXT: "IsBuiltIn": true,
|
|
// CHECK-NEXT: "IsTemplate": false,
|
|
// CHECK-NEXT: "Name": "int",
|
|
// CHECK-NEXT: "QualName": "int",
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}",
|
|
// CHECK-NEXT: "VerticalDisplay": false
|
|
// CHECK-NEXT: },
|
|
// CHECK: "IsStatic": true,
|
|
// CHECK: "Name": "getConst",
|
|
// CHECK: "ReturnType": {
|
|
// CHECK-NEXT: "IsBuiltIn": false,
|
|
// CHECK-NEXT: "IsTemplate": false,
|
|
// CHECK-NEXT: "Name": "const int &",
|
|
// CHECK-NEXT: "QualName": "const int &",
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: },
|
|
// CHECK: "Records": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "DocumentationFileName": "_ZTVN7MyClass11NestedClassE",
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "Name": "NestedClass",
|
|
// CHECK-NEXT: "Path": "GlobalNamespace{{[\/]+}}MyClass",
|
|
// CHECK-NEXT: "PathStem": "MyClass",
|
|
// CHECK-NEXT: "QualName": "NestedClass",
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: }
|
|
// CHECK-NEXT: ]
|
|
// CHECK-NEXT: "TagType": "struct",
|
|
// CHECK-NEXT: "Typedefs": [
|
|
// CHECK-NEXT: {
|
|
// CHECK-NEXT: "End": true,
|
|
// CHECK-NEXT: "InfoType": "typedef",
|
|
// CHECK-NEXT: "IsUsing": false,
|
|
// CHECK-NEXT: "Location": {
|
|
// CHECK-NEXT: "Filename": "{{.*}}class.cpp",
|
|
// CHECK-NEXT: "LineNumber": 25
|
|
// CHECK-NEXT: },
|
|
// CHECK-NEXT: "Name": "MyTypedef",
|
|
// CHECK-NEXT: "Namespace": [
|
|
// CHECK-NEXT: "MyClass",
|
|
// CHECK-NEXT: "GlobalNamespace"
|
|
// CHECK-NEXT: ],
|
|
// CHECK-NEXT: "TypeDeclaration": "",
|
|
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}",
|
|
// CHECK-NEXT: "Underlying": {
|
|
// CHECK-NEXT: "IsBuiltIn": true,
|
|
// CHECK-NEXT: "IsTemplate": false,
|
|
// CHECK-NEXT: "Name": "int",
|
|
// CHECK-NEXT: "QualName": "int",
|
|
// CHECK-NEXT: "USR": "0000000000000000000000000000000000000000"
|
|
// CHECK: "USR": "{{[0-9A-F]*}}"
|
|
// CHECK-NEXT: }
|
|
|
|
// HTML: <a class="sidebar-item" href="#Records">Records</a>
|
|
// HTML-NEXT: </summary>
|
|
// HTML-NEXT: <ul>
|
|
// HTML-NEXT: <li class="sidebar-item-container">
|
|
// HTML-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">NestedClass</a>
|
|
// HTML-NEXT: </li>
|
|
// HTML-NEXT: </ul>
|
|
// HTML-NEXT: </details>
|
|
// HTML: <a class="sidebar-item" href="#Friends">Friends</a>
|
|
// HTML-NEXT: </summary>
|
|
// HTML-NEXT: <ul>
|
|
// HTML-NEXT: <li class="sidebar-item-container">
|
|
// HTML-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">friendFunction</a>
|
|
// HTML-NEXT: </li>
|
|
// HTML-NEXT: <li class="sidebar-item-container">
|
|
// HTML-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">Foo</a>
|
|
// HTML-NEXT: </li>
|
|
// HTML-NEXT: </ul>
|
|
// HTML-NEXT: </details>
|
|
// HTML: <section id="ProtectedMembers" class="section-container">
|
|
// HTML-NEXT: <h2>Protected Members</h2>
|
|
// HTML-NEXT: <div>
|
|
// HTML-NEXT: <div id="ProtectedField" class="delimiter-container">
|
|
// HTML-NEXT: <pre><code class="language-cpp code-clang-doc" >int ProtectedField</code></pre>
|
|
// HTML-NEXT: </div>
|
|
// HTML-NEXT: </div>
|
|
// HTML-NEXT: </section>
|
|
// HTML: <section id="ProtectedMethods" class="section-container">
|
|
// HTML-NEXT: <h2>Protected Methods</h2>
|
|
// HTML-NEXT: <div>
|
|
// HTML-NEXT: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
// HTML-NEXT: <pre><code class="language-cpp code-clang-doc">int protectedMethod ()</code></pre>
|
|
// HTML-NEXT: </div>
|
|
// HTML-NEXT: </div>
|
|
// HTML-NEXT: </section>
|
|
// HTML: <section id="Records" class="section-container">
|
|
// HTML-NEXT: <h2>Records</h2>
|
|
// HTML-NEXT: <ul class="class-container">
|
|
// HTML-NEXT: <li id="{{([0-9A-F]{40})}}" style="max-height: 40px;">
|
|
// HTML-NEXT: <a href="MyClass/_ZTVN7MyClass11NestedClassE.html">
|
|
// HTML-NEXT: <pre><code class="language-cpp code-clang-doc">class NestedClass</code></pre>
|
|
// HTML-NEXT: </a>
|
|
// HTML-NEXT: </li>
|
|
// HTML-NEXT: </ul>
|
|
// HTML-NEXT: </section>
|
|
// HTML: <section id="Friends" class="section-container">
|
|
// HTML-NEXT: <h2>Friends</h2>
|
|
// HTML-NEXT: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
// HTML-NEXT: <pre><code class="language-cpp code-clang-doc">template <typename T></code></pre>
|
|
// HTML-NEXT: <pre><code class="language-cpp code-clang-doc">void MyClass (int )</code></pre>
|
|
// HTML-NEXT: </div>
|
|
// HTML-NEXT: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
// HTML-NEXT: <pre><code class="language-cpp code-clang-doc">class Foo</code></pre>
|
|
// HTML-NEXT: </div>
|
|
// HTML-NEXT: </section>
|