An example struct from which these commands will hang. @brief This is a sample brief. @warning This is a sample warning. @par header This is a sample paragraph. @hyde-owner fosterbrereton @see [Slides](https://llvm.org/devmtg/2012-11/Gribenko_CommentParsing.pdf) from an LLVM dev meeting chat on the comment parsing feature
| 31 | /// @hyde-owner fosterbrereton |
| 32 | /// @see [Slides](https://llvm.org/devmtg/2012-11/Gribenko_CommentParsing.pdf) from an LLVM dev meeting chat on the comment parsing feature |
| 33 | struct some_struct { |
| 34 | virtual ~some_struct() = delete; |
| 35 | |
| 36 | /// This is a longer description of this function that does things as well as it does. |
| 37 | /// Notice how long this comment is! So impressive. 💥 |
| 38 | /// @brief A function that does a thing, and does it well. |
| 39 | /// @param[in] input an input parameter |
| 40 | /// @param[in,out] input_output a bidirectional parameter |
| 41 | /// @param[out] output an output parameter |
| 42 | /// @pre An example precondition. |
| 43 | /// @post An example postcondition. |
| 44 | /// @return Some additional value. |
| 45 | /// @throw `std::runtime_error` if the function actually _can't_ do the thing. Sorry! |
| 46 | /// @todo This really could use some cleanup. Although, its implementation doesn't exist... |
| 47 | /// @warning This function may be very expensive to run. Do not call it inside a loop. |
| 48 | int some_function(int input, int& input_output, int& output); |
| 49 | |
| 50 | /// A virtual function that intends to be overridden. |
| 51 | virtual void virtual_function(); |
| 52 | |
| 53 | int _x{0}; ///< A trailing comment that documents `_x`. |
| 54 | }; |
| 55 | |
| 56 | /// Notice how many of the comments for this structure are inherited from its superclass. |
| 57 | /// @brief This is a sample brief for `some_other_struct` |
nothing calls this directly
no outgoing calls
no test coverage detected