derek.holloway
7502bf64a4
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
658 lines
38 KiB
Plaintext
658 lines
38 KiB
Plaintext
// 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/html/GlobalNamespace/_ZTV5Shape.html -check-prefix=HTML-SHAPE
|
|
// RUN: FileCheck %s -input-file=%t/docs/html/GlobalNamespace/_ZTV10Calculator.html -check-prefix=HTML-CALC
|
|
// RUN: FileCheck %s -input-file=%t/docs/html/GlobalNamespace/_ZTV9Rectangle.html -check-prefix=HTML-RECTANGLE
|
|
// RUN: FileCheck %s -input-file=%t/docs/html/GlobalNamespace/_ZTV6Circle.html -check-prefix=HTML-CIRCLE
|
|
|
|
// RUN: clang-doc --format=md_mustache --output=%t/docs --executor=all-TUs %t/build/compile_commands.json
|
|
// RUN: FileCheck %s -input-file=%t/docs/md/all_files.md -check-prefixes=MD-ALL-FILES
|
|
// RUN: FileCheck %s -input-file=%t/docs/md/index.md -check-prefixes=MD-INDEX
|
|
// RUN: FileCheck %s -input-file=%t/docs/md/GlobalNamespace/_ZTV5Shape.md -check-prefixes=MD-SHAPE
|
|
// RUN: FileCheck %s -input-file=%t/docs/md/GlobalNamespace/_ZTV10Calculator.md -check-prefixes=MD-CALC
|
|
// RUN: FileCheck %s -input-file=%t/docs/md/GlobalNamespace/_ZTV9Rectangle.md -check-prefixes=MD-RECTANGLE
|
|
// RUN: FileCheck %s -input-file=%t/docs/md/GlobalNamespace/_ZTV6Circle.md -check-prefixes=MD-CIRCLE
|
|
|
|
HTML-SHAPE-LABEL:<html lang="en-US">
|
|
HTML-SHAPE-NEXT: <head>
|
|
HTML-SHAPE: </head>
|
|
HTML-SHAPE-LABEL:<body>
|
|
HTML-SHAPE-NEXT: <header>
|
|
HTML-SHAPE-NEXT: <nav class="navbar">
|
|
HTML-SHAPE-NEXT: <div class="navbar__container">
|
|
HTML-SHAPE-NEXT: <div class="navbar__logo">
|
|
HTML-SHAPE: <div class="navbar__menu">
|
|
HTML-SHAPE: <a href="../index.html" class="navbar__link">Home</a>
|
|
HTML-SHAPE: <div class="navbar-breadcrumb-container">
|
|
HTML-SHAPE-NEXT: <a href="./index.html"><div class="navbar-breadcrumb-item">Global Namespace</div></a>
|
|
HTML-SHAPE: </nav>
|
|
HTML-SHAPE-NEXT: <script>
|
|
HTML-SHAPE: </header>
|
|
HTML-SHAPE-LABEL:<main>
|
|
HTML-SHAPE-NEXT: <div class="container">
|
|
HTML-SHAPE-NEXT: <div class="sidebar">
|
|
HTML-SHAPE-NEXT: <h2>class Shape</h2>
|
|
HTML-SHAPE-NEXT: <ul>
|
|
HTML-SHAPE-NEXT: <li>
|
|
HTML-SHAPE-NEXT: <details open>
|
|
HTML-SHAPE-NEXT: <summary class="sidebar-section">
|
|
HTML-SHAPE-NEXT: <a class="sidebar-item" href="#PublicMethods">Public Methods</a>
|
|
HTML-SHAPE-NEXT: </summary>
|
|
HTML-SHAPE-NEXT: <ul>
|
|
HTML-SHAPE-NEXT: <li class="sidebar-item-container">
|
|
HTML-SHAPE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">area</a>
|
|
HTML-SHAPE-NEXT: </li>
|
|
HTML-SHAPE-NEXT: <li class="sidebar-item-container">
|
|
HTML-SHAPE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">perimeter</a>
|
|
HTML-SHAPE-NEXT: </li>
|
|
HTML-SHAPE-NEXT: <li class="sidebar-item-container">
|
|
HTML-SHAPE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">~Shape</a>
|
|
HTML-SHAPE-NEXT: </li>
|
|
HTML-SHAPE-NEXT: </ul>
|
|
HTML-SHAPE-NEXT: </details>
|
|
HTML-SHAPE-NEXT: </li>
|
|
HTML-SHAPE-NEXT: </ul>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-LABEL: <div class="resizer" id="resizer"></div>
|
|
HTML-SHAPE-NEXT: <div class="content">
|
|
HTML-SHAPE-NEXT: <section class="hero section-container">
|
|
HTML-SHAPE-NEXT: <div class="hero__title">
|
|
HTML-SHAPE-NEXT: <h1 class="hero__title-large">class Shape</h1>
|
|
HTML-SHAPE-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}include{{[\/]}}Shape.h</p>
|
|
HTML-SHAPE-NEXT: <div class="doc-card">
|
|
HTML-SHAPE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-SHAPE-NEXT: <p>Abstract base class for shapes.</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-SHAPE-NEXT: <p>Provides a common interface for different types of shapes.</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </section>
|
|
HTML-SHAPE-NEXT: <section id="PublicMethods" class="section-container">
|
|
HTML-SHAPE-NEXT: <h2>Public Methods</h2>
|
|
HTML-SHAPE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-SHAPE-NEXT: <pre><code class="language-cpp code-clang-doc">double area ()</code></pre>
|
|
HTML-SHAPE-NEXT: <div class="doc-card">
|
|
HTML-SHAPE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-SHAPE-NEXT: <p>Calculates the area of the shape.</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-SHAPE-NEXT: <h3>Returns</h3>
|
|
HTML-SHAPE-NEXT: <p>double The area of the shape.</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-SHAPE-NEXT: <pre><code class="language-cpp code-clang-doc">double perimeter ()</code></pre>
|
|
HTML-SHAPE-NEXT: <div class="doc-card">
|
|
HTML-SHAPE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-SHAPE-NEXT: <p>Calculates the perimeter of the shape.</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-SHAPE-NEXT: <h3>Returns</h3>
|
|
HTML-SHAPE-NEXT: <p>double The perimeter of the shape.</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-SHAPE-NEXT: <pre><code class="language-cpp code-clang-doc">void ~Shape ()</code></pre>
|
|
HTML-SHAPE-NEXT: <div class="doc-card">
|
|
HTML-SHAPE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-SHAPE-NEXT: <p>Virtual destructor.</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}include{{[/\\]}}Shape.h</p>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </section>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </div>
|
|
HTML-SHAPE-NEXT: </main>
|
|
HTML-SHAPE-NEXT: </body>
|
|
HTML-SHAPE-NEXT: </html>
|
|
|
|
|
|
HTML-CALC-LABEL:<html lang="en-US">
|
|
HTML-CALC-NEXT: <head>
|
|
HTML-CALC: </head>
|
|
HTML-CALC-LABEL:<body>
|
|
HTML-CALC-NEXT: <header>
|
|
HTML-CALC-NEXT: <nav class="navbar">
|
|
HTML-CALC-NEXT: <div class="navbar__container">
|
|
HTML-CALC-NEXT: <div class="navbar__logo">
|
|
HTML-CALC: <div class="navbar__menu">
|
|
HTML-CALC: <a href="../index.html" class="navbar__link">Home</a>
|
|
HTML-CALC: <div class="navbar-breadcrumb-container">
|
|
HTML-CALC-NEXT: <a href="./index.html"><div class="navbar-breadcrumb-item">Global Namespace</div></a>
|
|
HTML-CALC: </nav>
|
|
HTML-CALC-NEXT: <script>
|
|
HTML-CALC: </header>
|
|
HTML-CALC-LABEL:<main>
|
|
HTML-CALC-NEXT: <div class="container">
|
|
HTML-CALC-NEXT: <div class="sidebar">
|
|
HTML-CALC-NEXT: <h2>class Calculator</h2>
|
|
HTML-CALC-NEXT: <ul>
|
|
HTML-CALC-NEXT: <li>
|
|
HTML-CALC-NEXT: <details open>
|
|
HTML-CALC-NEXT: <summary class="sidebar-section">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#PublicMembers">Public Members</a>
|
|
HTML-CALC-NEXT: </summary>
|
|
HTML-CALC-NEXT: <ul>
|
|
HTML-CALC-NEXT: <li class="sidebar-item-container">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#public_val">public_val</a>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: <li class="sidebar-item-container">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#static_val">static_val</a>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: </ul>
|
|
HTML-CALC-NEXT: </details>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: <li>
|
|
HTML-CALC-NEXT: <details open>
|
|
HTML-CALC-NEXT: <summary class="sidebar-section">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#PublicMethods">Public Methods</a>
|
|
HTML-CALC-NEXT: </summary>
|
|
HTML-CALC-NEXT: <ul>
|
|
HTML-CALC-NEXT: <li class="sidebar-item-container">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">add</a>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: <li class="sidebar-item-container">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">subtract</a>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: <li class="sidebar-item-container">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">multiply</a>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: <li class="sidebar-item-container">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">divide</a>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: <li class="sidebar-item-container">
|
|
HTML-CALC-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">mod</a>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: </ul>
|
|
HTML-CALC-NEXT: </details>
|
|
HTML-CALC-NEXT: </li>
|
|
HTML-CALC-NEXT: </ul>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-LABEL: <div class="resizer" id="resizer"></div>
|
|
HTML-CALC-NEXT: <div class="content">
|
|
HTML-CALC-NEXT: <section class="hero section-container">
|
|
HTML-CALC-NEXT: <div class="hero__title">
|
|
HTML-CALC-NEXT: <h1 class="hero__title-large">class Calculator</h1>
|
|
HTML-CALC-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}include{{[/\\]}}Calculator.h</p>
|
|
HTML-CALC-NEXT: <div class="doc-card">
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <p>A simple calculator class.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <p>Provides basic arithmetic operations.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </section>
|
|
HTML-CALC-NEXT: <section id="PublicMembers" class="section-container">
|
|
HTML-CALC-NEXT: <h2>Public Members</h2>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <div id="public_val" class="delimiter-container">
|
|
HTML-CALC-NEXT: <pre><code class="language-cpp code-clang-doc" >int public_val</code></pre>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div id="static_val" class="delimiter-container">
|
|
HTML-CALC-NEXT: <pre><code class="language-cpp code-clang-doc" >static const int static_val</code></pre>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </section>
|
|
HTML-CALC-NEXT: <section id="PublicMethods" class="section-container">
|
|
HTML-CALC-NEXT: <h2>Public Methods</h2>
|
|
HTML-CALC-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CALC-NEXT: <pre><code class="language-cpp code-clang-doc">int add (int a, int b)</code></pre>
|
|
HTML-CALC-NEXT: <div class="doc-card">
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <p>Adds two integers.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Parameters</h3>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>a</b> First integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>b</b> Second integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Returns</h3>
|
|
HTML-CALC-NEXT: <p>int The sum of a and b.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CALC-NEXT: <pre><code class="language-cpp code-clang-doc">int subtract (int a, int b)</code></pre>
|
|
HTML-CALC-NEXT: <div class="doc-card">
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <p>Subtracts the second integer from the first.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Parameters</h3>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>a</b> First integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>b</b> Second integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Returns</h3>
|
|
HTML-CALC-NEXT: <p>int The result of a - b.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CALC-NEXT: <pre><code class="language-cpp code-clang-doc">int multiply (int a, int b)</code></pre>
|
|
HTML-CALC-NEXT: <div class="doc-card">
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <p>Multiplies two integers.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Parameters</h3>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>a</b> First integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>b</b> Second integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Returns</h3>
|
|
HTML-CALC-NEXT: <p>int The product of a and b.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CALC-NEXT: <pre><code class="language-cpp code-clang-doc">double divide (int a, int b)</code></pre>
|
|
HTML-CALC-NEXT: <div class="doc-card">
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <p>Divides the first integer by the second.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Parameters</h3>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>a</b> First integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>b</b> Second integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Returns</h3>
|
|
HTML-CALC-NEXT: <p>double The result of a / b.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Throws</h3>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>std::invalid_argument</b> if b is zero.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CALC-NEXT: <pre><code class="language-cpp code-clang-doc">int mod (int a, int b)</code></pre>
|
|
HTML-CALC-NEXT: <div class="doc-card">
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <p>Performs the mod operation on integers.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Parameters</h3>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>a</b> First integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div>
|
|
HTML-CALC-NEXT: <b>b</b> Second integer.
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CALC-NEXT: <h3>Returns</h3>
|
|
HTML-CALC-NEXT: <p>The result of a % b.</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}include{{[/\\]}}Calculator.h</p>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </section>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </div>
|
|
HTML-CALC-NEXT: </main>
|
|
HTML-CALC-NEXT: </body>
|
|
HTML-CALC-NEXT: </html>
|
|
|
|
|
|
HTML-RECTANGLE-LABEL:<html lang="en-US">
|
|
HTML-RECTANGLE-NEXT: <head>
|
|
HTML-RECTANGLE: </head>
|
|
HTML-RECTANGLE-LABEL:<body>
|
|
HTML-RECTANGLE-NEXT: <header>
|
|
HTML-RECTANGLE-NEXT: <nav class="navbar">
|
|
HTML-RECTANGLE-NEXT: <div class="navbar__container">
|
|
HTML-RECTANGLE-NEXT: <div class="navbar__logo">
|
|
HTML-RECTANGLE: <div class="navbar__menu">
|
|
HTML-RECTANGLE: <a href="../index.html" class="navbar__link">Home</a>
|
|
HTML-RECTANGLE: <div class="navbar-breadcrumb-container">
|
|
HTML-RECTANGLE-NEXT: <a href="./index.html"><div class="navbar-breadcrumb-item">Global Namespace</div></a>
|
|
HTML-RECTANGLE: </nav>
|
|
HTML-RECTANGLE-NEXT: <script>
|
|
HTML-RECTANGLE: </header>
|
|
HTML-RECTANGLE-LABEL:<main>
|
|
HTML-RECTANGLE-NEXT: <div class="container">
|
|
HTML-RECTANGLE-NEXT: <div class="sidebar">
|
|
HTML-RECTANGLE-NEXT: <h2>class Rectangle</h2>
|
|
HTML-RECTANGLE-NEXT: <ul>
|
|
HTML-RECTANGLE-NEXT: <li>
|
|
HTML-RECTANGLE-NEXT: <details open>
|
|
HTML-RECTANGLE-NEXT: <summary class="sidebar-section">
|
|
HTML-RECTANGLE-NEXT: <a class="sidebar-item" href="#PublicMethods">Public Methods</a>
|
|
HTML-RECTANGLE-NEXT: </summary>
|
|
HTML-RECTANGLE-NEXT: <ul>
|
|
HTML-RECTANGLE-NEXT: <li class="sidebar-item-container">
|
|
HTML-RECTANGLE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">Rectangle</a>
|
|
HTML-RECTANGLE-NEXT: </li>
|
|
HTML-RECTANGLE-NEXT: <li class="sidebar-item-container">
|
|
HTML-RECTANGLE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">area</a>
|
|
HTML-RECTANGLE-NEXT: </li>
|
|
HTML-RECTANGLE-NEXT: <li class="sidebar-item-container">
|
|
HTML-RECTANGLE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">perimeter</a>
|
|
HTML-RECTANGLE-NEXT: </li>
|
|
HTML-RECTANGLE-NEXT: </ul>
|
|
HTML-RECTANGLE-NEXT: </details>
|
|
HTML-RECTANGLE-NEXT: </li>
|
|
HTML-RECTANGLE-NEXT: </ul>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-LABEL: <div class="resizer" id="resizer"></div>
|
|
HTML-RECTANGLE-NEXT: <div class="content">
|
|
HTML-RECTANGLE-NEXT: <section class="hero section-container">
|
|
HTML-RECTANGLE-NEXT: <div class="hero__title">
|
|
HTML-RECTANGLE-NEXT: <h1 class="hero__title-large">class Rectangle</h1>
|
|
HTML-RECTANGLE-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}include{{[/\\]}}Rectangle.h</p>
|
|
HTML-RECTANGLE-NEXT: <div class="doc-card">
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <p>Rectangle class derived from Shape.</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <p>Represents a rectangle with a given width and height.</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </section>
|
|
HTML-RECTANGLE-NEXT: <section id="PublicMethods" class="section-container">
|
|
HTML-RECTANGLE-NEXT: <h2>Public Methods</h2>
|
|
HTML-RECTANGLE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <pre><code class="language-cpp code-clang-doc">void Rectangle (double width, double height)</code></pre>
|
|
HTML-RECTANGLE-NEXT: <div class="doc-card">
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <p>Constructs a new Rectangle object.</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <h3>Parameters</h3>
|
|
HTML-RECTANGLE-NEXT: <div>
|
|
HTML-RECTANGLE-NEXT: <b>width</b> Width of the rectangle.
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: <div>
|
|
HTML-RECTANGLE-NEXT: <b>height</b> Height of the rectangle.
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <pre><code class="language-cpp code-clang-doc">double area ()</code></pre>
|
|
HTML-RECTANGLE-NEXT: <div class="doc-card">
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <p>Calculates the area of the rectangle.</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <h3>Returns</h3>
|
|
HTML-RECTANGLE-NEXT: <p>double The area of the rectangle.</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <pre><code class="language-cpp code-clang-doc">double perimeter ()</code></pre>
|
|
HTML-RECTANGLE-NEXT: <div class="doc-card">
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <p>Calculates the perimeter of the rectangle.</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-RECTANGLE-NEXT: <h3>Returns</h3>
|
|
HTML-RECTANGLE-NEXT: <p>double The perimeter of the rectangle.</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}src{{[/\\]}}Rectangle.cpp</p>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </section>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </div>
|
|
HTML-RECTANGLE-NEXT: </main>
|
|
HTML-RECTANGLE-NEXT: </body>
|
|
HTML-RECTANGLE-NEXT: </html>
|
|
|
|
|
|
HTML-CIRCLE-LABEL:<html lang="en-US">
|
|
HTML-CIRCLE-NEXT: <head>
|
|
HTML-CIRCLE: </head>
|
|
HTML-CIRCLE-LABEL:<body>
|
|
HTML-CIRCLE-NEXT: <header>
|
|
HTML-CIRCLE-NEXT: <nav class="navbar">
|
|
HTML-CIRCLE-NEXT: <div class="navbar__container">
|
|
HTML-CIRCLE-NEXT: <div class="navbar__logo">
|
|
HTML-CIRCLE: <div class="navbar__menu">
|
|
HTML-CIRCLE: <a href="../index.html" class="navbar__link">Home</a>
|
|
HTML-CIRCLE: <div class="navbar-breadcrumb-container">
|
|
HTML-CIRCLE-NEXT: <a href="./index.html"><div class="navbar-breadcrumb-item">Global Namespace</div></a>
|
|
HTML-CIRCLE: </nav>
|
|
HTML-CIRCLE-NEXT: <script>
|
|
HTML-CIRCLE: </header>
|
|
HTML-CIRCLE-LABEL:<main>
|
|
HTML-CIRCLE-NEXT: <div class="container">
|
|
HTML-CIRCLE-NEXT: <div class="sidebar">
|
|
HTML-CIRCLE-NEXT: <h2>class Circle</h2>
|
|
HTML-CIRCLE-NEXT: <ul>
|
|
HTML-CIRCLE-NEXT: <li>
|
|
HTML-CIRCLE-NEXT: <details open>
|
|
HTML-CIRCLE-NEXT: <summary class="sidebar-section">
|
|
HTML-CIRCLE-NEXT: <a class="sidebar-item" href="#PublicMethods">Public Methods</a>
|
|
HTML-CIRCLE-NEXT: </summary>
|
|
HTML-CIRCLE-NEXT: <ul>
|
|
HTML-CIRCLE-NEXT: <li class="sidebar-item-container">
|
|
HTML-CIRCLE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">Circle</a>
|
|
HTML-CIRCLE-NEXT: </li>
|
|
HTML-CIRCLE-NEXT: <li class="sidebar-item-container">
|
|
HTML-CIRCLE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">area</a>
|
|
HTML-CIRCLE-NEXT: </li>
|
|
HTML-CIRCLE-NEXT: <li class="sidebar-item-container">
|
|
HTML-CIRCLE-NEXT: <a class="sidebar-item" href="#{{([0-9A-F]{40})}}">perimeter</a>
|
|
HTML-CIRCLE-NEXT: </li>
|
|
HTML-CIRCLE-NEXT: </ul>
|
|
HTML-CIRCLE-NEXT: </details>
|
|
HTML-CIRCLE-NEXT: </li>
|
|
HTML-CIRCLE-NEXT: </ul>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-LABEL: <div class="resizer" id="resizer"></div>
|
|
HTML-CIRCLE-NEXT: <div class="content">
|
|
HTML-CIRCLE-NEXT: <section class="hero section-container">
|
|
HTML-CIRCLE-NEXT: <div class="hero__title">
|
|
HTML-CIRCLE-NEXT: <h1 class="hero__title-large">class Circle</h1>
|
|
HTML-CIRCLE-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}include{{[/\\]}}Circle.h</p>
|
|
HTML-CIRCLE-NEXT: <div class="doc-card">
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <p>Circle class derived from Shape.</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <p>Represents a circle with a given radius.</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </section>
|
|
HTML-CIRCLE-NEXT: <section id="PublicMethods" class="section-container">
|
|
HTML-CIRCLE-NEXT: <h2>Public Methods</h2>
|
|
HTML-CIRCLE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CIRCLE-NEXT: <pre><code class="language-cpp code-clang-doc">void Circle (double radius)</code></pre>
|
|
HTML-CIRCLE-NEXT: <div class="doc-card">
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <p>Constructs a new Circle object.</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <h3>Parameters</h3>
|
|
HTML-CIRCLE-NEXT: <div>
|
|
HTML-CIRCLE-NEXT: <b>radius</b> Radius of the circle.
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CIRCLE-NEXT: <pre><code class="language-cpp code-clang-doc">double area ()</code></pre>
|
|
HTML-CIRCLE-NEXT: <div class="doc-card">
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <p>Calculates the area of the circle.</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <h3>Returns</h3>
|
|
HTML-CIRCLE-NEXT: <p>double The area of the circle.</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-LABEL: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
|
|
HTML-CIRCLE-NEXT: <pre><code class="language-cpp code-clang-doc">double perimeter ()</code></pre>
|
|
HTML-CIRCLE-NEXT: <div class="doc-card">
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <p>Calculates the perimeter of the circle.</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: <div class="nested-delimiter-container">
|
|
HTML-CIRCLE-NEXT: <h3>Returns</h3>
|
|
HTML-CIRCLE-NEXT: <p>double The perimeter of the circle.</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: <h3>Code</h3>
|
|
HTML-CIRCLE-NEXT: <div>
|
|
HTML-CIRCLE-NEXT: <pre class="code-block">
|
|
HTML-CIRCLE-NEXT: <code>
|
|
HTML-CIRCLE-NEXT: Circle circle(5.0);
|
|
HTML-CIRCLE-NEXT: double perimeter = circle.perimeter();
|
|
HTML-CIRCLE-NEXT: </code>
|
|
HTML-CIRCLE-NEXT: </pre>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: <p>Defined at line {{[0-9]+}} of file {{.*}}src{{[/\\]}}Circle.cpp</p>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </section>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </div>
|
|
HTML-CIRCLE-NEXT: </main>
|
|
HTML-CIRCLE-NEXT: </body>
|
|
HTML-CIRCLE-NEXT: </html>
|
|
|
|
MD-CALC: # class Calculator
|
|
MD-CALC: *Defined at .{{[\/]}}include{{[\/]}}Calculator.h#8*
|
|
MD-CALC: **brief** A simple calculator class.
|
|
MD-CALC: Provides basic arithmetic operations.
|
|
MD-CALC: ## Members
|
|
MD-CALC: public int public_val
|
|
MD-CALC: public static const int static_val
|
|
MD-CALC: ## Functions
|
|
MD-CALC: ### add
|
|
MD-CALC: *public int add(int a, int b)*
|
|
MD-CALC: *Defined at .{{[\/]}}src{{[\/]}}Calculator.cpp#3*
|
|
MD-CALC: **brief** Adds two integers.
|
|
MD-CALC: **a** First integer.
|
|
MD-CALC: **b** Second integer.
|
|
MD-CALC: **return** int The sum of a and b.
|
|
MD-CALC: ### subtract
|
|
MD-CALC: *public int subtract(int a, int b)*
|
|
MD-CALC: *Defined at .{{[\/]}}src{{[\/]}}Calculator.cpp#7*
|
|
MD-CALC: **brief** Subtracts the second integer from the first.
|
|
MD-CALC: **a** First integer.
|
|
MD-CALC: **b** Second integer.
|
|
MD-CALC: **return** int The result of a - b.
|
|
MD-CALC: ### multiply
|
|
MD-CALC: *public int multiply(int a, int b)*
|
|
MD-CALC: *Defined at .{{[\/]}}src{{[\/]}}Calculator.cpp#11*
|
|
MD-CALC: **brief** Multiplies two integers.
|
|
MD-CALC: **a** First integer.
|
|
MD-CALC: **b** Second integer.
|
|
MD-CALC: **return** int The product of a and b.
|
|
MD-CALC: ### divide
|
|
MD-CALC: *public double divide(int a, int b)*
|
|
MD-CALC: *Defined at .{{[\/]}}src{{[\/]}}Calculator.cpp#15*
|
|
MD-CALC: **brief** Divides the first integer by the second.
|
|
MD-CALC: **a** First integer.
|
|
MD-CALC: **b** Second integer.
|
|
MD-CALC: **return** double The result of a / b.
|
|
MD-CALC: **throw** if b is zero.
|
|
MD-CALC: ### mod
|
|
MD-CALC: *public static int mod(int a, int b)*
|
|
MD-CALC: *Defined at ./include{{[\/]}}Calculator.h#54*
|
|
MD-CALC: **brief** Performs the mod operation on integers.
|
|
MD-CALC: **a** First integer.
|
|
MD-CALC: **b** Second integer.
|
|
MD-CALC: **return** The result of a % b.
|
|
|
|
MD-CIRCLE: # class Circle
|
|
MD-CIRCLE: *Defined at .{{[\/]}}include{{[\/]}}Circle.h#10*
|
|
MD-CIRCLE: **brief** Circle class derived from Shape.
|
|
MD-CIRCLE: Represents a circle with a given radius.
|
|
MD-CIRCLE: Inherits from Shape
|
|
MD-CIRCLE: ## Members
|
|
MD-CIRCLE: private double radius_
|
|
MD-CIRCLE: ## Functions
|
|
MD-CIRCLE: ### Circle
|
|
MD-CIRCLE: *public void Circle(double radius)*
|
|
MD-CIRCLE: *Defined at .{{[\/]}}src{{[\/]}}Circle.cpp#3*
|
|
MD-CIRCLE: **brief** Constructs a new Circle object.
|
|
MD-CIRCLE: **radius** Radius of the circle.
|
|
MD-CIRCLE: ### area
|
|
MD-CIRCLE: *public double area()*
|
|
MD-CIRCLE: *Defined at .{{[\/]}}src{{[\/]}}Circle.cpp#5*
|
|
MD-CIRCLE: **brief** Calculates the area of the circle.
|
|
MD-CIRCLE: **return** double The area of the circle.
|
|
MD-CIRCLE: ### perimeter
|
|
MD-CIRCLE: *public double perimeter()*
|
|
MD-CIRCLE: *Defined at .{{[\/]}}src{{[\/]}}Circle.cpp#9*
|
|
MD-CIRCLE: **brief** Calculates the perimeter of the circle.
|
|
MD-CIRCLE: **return** double The perimeter of the circle.
|
|
|
|
MD-RECTANGLE: # class Rectangle
|
|
MD-RECTANGLE: *Defined at .{{[\/]}}include{{[\/]}}Rectangle.h#10*
|
|
MD-RECTANGLE: **brief** Rectangle class derived from Shape.
|
|
MD-RECTANGLE: Represents a rectangle with a given width and height.
|
|
MD-RECTANGLE: Inherits from Shape
|
|
MD-RECTANGLE: ## Members
|
|
MD-RECTANGLE: private double width_
|
|
MD-RECTANGLE: private double height_
|
|
MD-RECTANGLE: ## Functions
|
|
MD-RECTANGLE: ### Rectangle
|
|
MD-RECTANGLE: *public void Rectangle(double width, double height)*
|
|
MD-RECTANGLE: *Defined at .{{[\/]}}src{{[\/]}}Rectangle.cpp#3*
|
|
MD-RECTANGLE: **brief** Constructs a new Rectangle object.
|
|
MD-RECTANGLE: **width** Width of the rectangle.
|
|
MD-RECTANGLE: **height** Height of the rectangle.
|
|
MD-RECTANGLE: ### area
|
|
MD-RECTANGLE: *public double area()*
|
|
MD-RECTANGLE: *Defined at .{{[\/]}}src{{[\/]}}Rectangle.cpp#6*
|
|
MD-RECTANGLE: **brief** Calculates the area of the rectangle.
|
|
MD-RECTANGLE: **return** double The area of the rectangle.
|
|
MD-RECTANGLE: ### perimeter
|
|
MD-RECTANGLE: *public double perimeter()*
|
|
MD-RECTANGLE: *Defined at .{{[\/]}}src{{[\/]}}Rectangle.cpp#10*
|
|
MD-RECTANGLE: **brief** Calculates the perimeter of the rectangle.
|
|
MD-RECTANGLE: **return** double The perimeter of the rectangle.
|
|
|
|
MD-SHAPE: # class Shape
|
|
MD-SHAPE: *Defined at .{{[\/]}}include{{[\/]}}Shape.h#8*
|
|
MD-SHAPE: **brief** Abstract base class for shapes.
|
|
MD-SHAPE: Provides a common interface for different types of shapes.
|
|
MD-SHAPE: ## Functions
|
|
MD-SHAPE: ### area
|
|
MD-SHAPE: *public double area()*
|
|
MD-SHAPE: **brief** Calculates the area of the shape.
|
|
MD-SHAPE: **return** double The area of the shape.
|
|
MD-SHAPE: ### perimeter
|
|
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)
|
|
|
|
MD-INDEX: # C/C++ Reference
|
|
MD-INDEX: * Namespace: [GlobalNamespace](GlobalNamespace)
|