clang-tools-extra/test/clang-doc/enum.cpp

// RUN: rm -rf %t && mkdir -p %t
// RUN: clang-doc --format=html --doxygen --output=%t --executor=standalone %s
// RUN: clang-doc --format=md --doxygen --output=%t --executor=standalone %s
// RUN: FileCheck %s < %t/html/GlobalNamespace/index.html --check-prefix=HTML-INDEX-LINE
// RUN: FileCheck %s < %t/html/GlobalNamespace/index.html --check-prefix=HTML-INDEX
// RUN: FileCheck %s < %t/html/GlobalNamespace/_ZTV7Animals.html --check-prefix=HTML-ANIMAL-LINE
// RUN: FileCheck %s < %t/html/GlobalNamespace/_ZTV7Animals.html --check-prefix=HTML-ANIMAL
// RUN: FileCheck %s < %t/html/Vehicles/index.html --check-prefix=HTML-VEHICLES-LINE
// RUN: FileCheck %s < %t/html/Vehicles/index.html --check-prefix=HTML-VEHICLES
// RUN: FileCheck %s < %t/GlobalNamespace/index.md --check-prefix=MD-INDEX-LINE
// RUN: FileCheck %s < %t/GlobalNamespace/index.md --check-prefix=MD-INDEX
// RUN: FileCheck %s < %t/GlobalNamespace/Animals.md --check-prefix=MD-ANIMAL-LINE
// RUN: FileCheck %s < %t/GlobalNamespace/Animals.md --check-prefix=MD-ANIMAL
// RUN: FileCheck %s < %t/Vehicles/index.md --check-prefix=MD-VEHICLES-LINE
// RUN: FileCheck %s < %t/Vehicles/index.md --check-prefix=MD-VEHICLES

// COM: FIXME: Add enum value comments to template

/**
 * @brief For specifying RGB colors
 */
enum Color {
  // MD-INDEX-LINE: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE-1]]*
  // HTML-INDEX-LINE-NOT: <p>Defined at line [[@LINE-2]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
  Red,   ///< Comment 1
  Green, ///< Comment 2
  Blue   ///< Comment 3
};

// MD-INDEX: ## Enums
// MD-INDEX: | enum Color |
// MD-INDEX: --
// MD-INDEX: | Red |
// MD-INDEX: | Green |
// MD-INDEX: | Blue |
// MD-INDEX: **brief** For specifying RGB colors

// HTML-INDEX:     <div>
// HTML-INDEX:         <pre><code class="language-cpp code-clang-doc">enum Color</code></pre>
// HTML-INDEX:     </div>
// HTML-INDEX:     <table class="table-wrapper">
// HTML-INDEX:         <tbody>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <th>Name</th>
// HTML-INDEX:                 <th>Value</th>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>Red</td>
// HTML-INDEX:                 <td>0</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>Green</td>
// HTML-INDEX:                 <td>1</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>Blue</td>
// HTML-INDEX:                 <td>2</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:         </tbody>
// HTML-INDEX:     </table>

/**
 * @brief Shape Types
 */
enum class Shapes {
  // MD-INDEX-LINE: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE-1]]*
  // HTML-INDEX-LINE-NOT: <p>Defined at line [[@LINE-2]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>

  /// Comment 1
  Circle,
  /// Comment 2
  Rectangle,
  /// Comment 3
  Triangle
};
// MD-INDEX: | enum class Shapes |
// MD-INDEX: --
// MD-INDEX: | Circle |
// MD-INDEX: | Rectangle |
// MD-INDEX: | Triangle |
// MD-INDEX: **brief** Shape Types

// COM: FIXME: Serialize "enum class" in template
// HTML-INDEX:     <div>
// HTML-INDEX:         <pre><code class="language-cpp code-clang-doc">enum Shapes</code></pre>
// HTML-INDEX:     </div>
// HTML-INDEX:     <table class="table-wrapper">
// HTML-INDEX:         <tbody>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <th>Name</th>
// HTML-INDEX:                 <th>Value</th>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>Circle</td>
// HTML-INDEX:                 <td>0</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>Rectangle</td>
// HTML-INDEX:                 <td>1</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>Triangle</td>
// HTML-INDEX:                 <td>2</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:         </tbody>
// HTML-INDEX:     </table>

// COM: FIXME: Add enums declared inside of classes to class template
class Animals {
  // MD-ANIMAL-LINE: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE-1]]*
  // HTML-ANIMAL-LINE: <p>Defined at line [[@LINE-2]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
public:
  /**
   * @brief specify what animal the class is
   */
  enum AnimalType {
    // MD-ANIMAL-LINE: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE-1]]*
    // HTML-ANIMAL-LINE-NOT: <p>Defined at line [[@LINE-2]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
    Dog,   ///< Man's best friend
    Cat,   ///< Man's other best friend
    Iguana ///< A lizard
  };
};

// HTML-ANIMAL-NOT: <h1>class Animals</h1>
// HTML-ANIMAL-NOT: <h2 id="Enums">Enums</h2>
// HTML-ANIMAL-NOT: <th colspan="3">enum AnimalType</th>
// HTML-ANIMAL-NOT: <td>Dog</td>
// HTML-ANIMAL-NOT: <td>0</td>
// HTML-ANIMAL-NOT: <p> Man&apos;s best friend</p>
// HTML-ANIMAL-NOT: <td>Cat</td>
// HTML-ANIMAL-NOT: <td>1</td>
// HTML-ANIMAL-NOT: <p> Man&apos;s other best friend</p>
// HTML-ANIMAL-NOT: <td>Iguana</td>
// HTML-ANIMAL-NOT: <td>2</td>
// HTML-ANIMAL-NOT: <p> A lizard</p>

// MD-ANIMAL: # class Animals
// MD-ANIMAL: ## Enums
// MD-ANIMAL: | enum AnimalType |
// MD-ANIMAL: --
// MD-ANIMAL: | Dog |
// MD-ANIMAL: | Cat |
// MD-ANIMAL: | Iguana |
// MD-ANIMAL: **brief** specify what animal the class is

namespace Vehicles {
/**
 * @brief specify type of car
 */
enum Car {
  // MD-VEHICLES-LINE: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE-1]]*
  // HTML-VEHICLES-LINE: Defined at line [[@LINE-2]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp

  Sedan,    ///< Comment 1
  SUV,      ///< Comment 2
  Pickup,   ///< Comment 3
  Hatchback ///< Comment 4
};
} // namespace Vehicles

// MD-VEHICLES: # namespace Vehicles
// MD-VEHICLES: ## Enums
// MD-VEHICLES: | enum Car |
// MD-VEHICLES: --
// MD-VEHICLES: | Sedan |
// MD-VEHICLES: | SUV |
// MD-VEHICLES: | Pickup |
// MD-VEHICLES: | Hatchback |
// MD-VEHICLES: **brief** specify type of car

// HTML-VEHICLES:     <div>
// HTML-VEHICLES:         <pre><code class="language-cpp code-clang-doc">enum Car</code></pre>
// HTML-VEHICLES:      </div>
// HTML-VEHICLES:      <table class="table-wrapper">
// HTML-VEHICLES:          <tbody>
// HTML-VEHICLES:              <tr>
// HTML-VEHICLES:                  <th>Name</th>
// HTML-VEHICLES:                  <th>Value</th>
// HTML-VEHICLES:              </tr>
// HTML-VEHICLES:              <tr>
// HTML-VEHICLES:                  <td>Sedan</td>
// HTML-VEHICLES:                  <td>0</td>
// HTML-VEHICLES:              </tr>
// HTML-VEHICLES:              <tr>
// HTML-VEHICLES:                  <td>SUV</td>
// HTML-VEHICLES:                  <td>1</td>
// HTML-VEHICLES:              </tr>
// HTML-VEHICLES:              <tr>
// HTML-VEHICLES:                  <td>Pickup</td>
// HTML-VEHICLES:                  <td>2</td>
// HTML-VEHICLES:              </tr>
// HTML-VEHICLES:              <tr>
// HTML-VEHICLES:                  <td>Hatchback</td>
// HTML-VEHICLES:                  <td>3</td>
// HTML-VEHICLES:              </tr>
// HTML-VEHICLES:          </tbody>
// HTML-VEHICLES:      </table>

enum ColorUserSpecified {
  RedUserSpecified = 'A',
  GreenUserSpecified = 2,
  BlueUserSpecified = 'C'
};

// MD-INDEX: | enum ColorUserSpecified |
// MD-INDEX: --
// MD-INDEX: | RedUserSpecified |
// MD-INDEX: | GreenUserSpecified |
// MD-INDEX: | BlueUserSpecified |

// HTML-INDEX:     <div>
// HTML-INDEX:         <pre><code class="language-cpp code-clang-doc">enum ColorUserSpecified</code></pre>
// HTML-INDEX:     </div>
// HTML-INDEX:     <table class="table-wrapper">
// HTML-INDEX:         <tbody>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <th>Name</th>
// HTML-INDEX:                 <th>Value</th>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>RedUserSpecified</td>
// HTML-INDEX:                 <td>&#39;A&#39;</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>GreenUserSpecified</td>
// HTML-INDEX:                 <td>2</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:             <tr>
// HTML-INDEX:                 <td>BlueUserSpecified</td>
// HTML-INDEX:                 <td>&#39;C&#39;</td>
// HTML-INDEX:             </tr>
// HTML-INDEX:         </tbody>
// HTML-INDEX:     </table>