|
| 1 | +--- |
| 2 | +layout: method |
| 3 | +title: overloaded |
| 4 | +hyde: |
| 5 | + owner: __INLINED__ |
| 6 | + brief: __INLINED__ |
| 7 | + tags: |
| 8 | + - method |
| 9 | + inline: |
| 10 | + brief: _multiple descriptions_ |
| 11 | + owner: fosterbrereton |
| 12 | + defined_in_file: classes.cpp |
| 13 | + overloads: |
| 14 | + void overloaded(): |
| 15 | + annotation: |
| 16 | + - deprecated |
| 17 | + description: __INLINED__ |
| 18 | + inline: |
| 19 | + description: |
| 20 | + - a deprecated overload that takes zero parameters. |
| 21 | + return: __OPTIONAL__ |
| 22 | + signature_with_names: void overloaded() |
| 23 | + void overloaded(const std::string &): |
| 24 | + arguments: |
| 25 | + - description: __OPTIONAL__ |
| 26 | + name: first |
| 27 | + type: const std::string & |
| 28 | + description: __INLINED__ |
| 29 | + inline: |
| 30 | + arguments: |
| 31 | + first: |
| 32 | + description: the first parameter of the first overload. |
| 33 | + brief: A series of overloaded functions. |
| 34 | + description: |
| 35 | + - an overloaded member function that takes one parameter. |
| 36 | + return: __OPTIONAL__ |
| 37 | + signature_with_names: void overloaded(const std::string & first) |
| 38 | + void overloaded(const std::string &, class_example *, int): |
| 39 | + arguments: |
| 40 | + - description: __OPTIONAL__ |
| 41 | + name: unnamed-0 |
| 42 | + type: const std::string & |
| 43 | + unnamed: true |
| 44 | + - description: __OPTIONAL__ |
| 45 | + name: unnamed-1 |
| 46 | + type: class_example * |
| 47 | + unnamed: true |
| 48 | + - description: __OPTIONAL__ |
| 49 | + name: unnamed-2 |
| 50 | + type: int |
| 51 | + unnamed: true |
| 52 | + description: __INLINED__ |
| 53 | + inline: |
| 54 | + description: |
| 55 | + - an overloaded member function that takes three unnamed parameters. Let it be known that Doxygen doesn't support documenting unnamed parameters at this time. There is a [bug open on the issue](https://github.com/doxygen/doxygen/issues/6926), but as of this writing does not appear to be progressing. |
| 56 | + return: __OPTIONAL__ |
| 57 | + signature_with_names: void overloaded(const std::string &, class_example *, int) |
| 58 | + void overloaded(const std::string &, class_example *, int, bool, std::size_t): |
| 59 | + arguments: |
| 60 | + - description: __OPTIONAL__ |
| 61 | + name: first |
| 62 | + type: const std::string & |
| 63 | + - description: __OPTIONAL__ |
| 64 | + name: second |
| 65 | + type: class_example * |
| 66 | + - description: __OPTIONAL__ |
| 67 | + name: third |
| 68 | + type: int |
| 69 | + - description: __OPTIONAL__ |
| 70 | + name: fourth |
| 71 | + type: bool |
| 72 | + - description: __OPTIONAL__ |
| 73 | + name: fifth |
| 74 | + type: std::size_t |
| 75 | + description: __INLINED__ |
| 76 | + inline: |
| 77 | + arguments: |
| 78 | + fifth: |
| 79 | + description: the fifth parameter of the fourth overload. |
| 80 | + first: |
| 81 | + description: the first parameter of the fourth overload. |
| 82 | + fourth: |
| 83 | + description: the fourth parameter of the fourth overload. |
| 84 | + second: |
| 85 | + description: the second parameter of the fourth overload. |
| 86 | + third: |
| 87 | + description: the third parameter of the fourth overload. |
| 88 | + description: |
| 89 | + - an overloaded member function that takes _five_ parameters. |
| 90 | + return: __OPTIONAL__ |
| 91 | + signature_with_names: void overloaded(const std::string & first, class_example * second, int third, bool fourth, std::size_t fifth) |
| 92 | + void overloaded(const std::string &, const std::string &) volatile: |
| 93 | + arguments: |
| 94 | + - description: __OPTIONAL__ |
| 95 | + name: first |
| 96 | + type: const std::string & |
| 97 | + - description: __OPTIONAL__ |
| 98 | + name: second |
| 99 | + type: const std::string & |
| 100 | + description: __INLINED__ |
| 101 | + inline: |
| 102 | + arguments: |
| 103 | + first: |
| 104 | + description: the first parameter of the second overload. |
| 105 | + second: |
| 106 | + description: the second parameter of the second overload. |
| 107 | + brief: Another brief describing one of the overloaded functions. |
| 108 | + description: |
| 109 | + - an overloaded member function that takes two parameters. |
| 110 | + return: __OPTIONAL__ |
| 111 | + signature_with_names: void overloaded(const std::string & first, const std::string & second) volatile |
| 112 | + void overloaded(const std::string &, std::vector<int>) const: |
| 113 | + arguments: |
| 114 | + - description: __OPTIONAL__ |
| 115 | + name: first |
| 116 | + type: const std::string & |
| 117 | + - description: __OPTIONAL__ |
| 118 | + name: second |
| 119 | + type: std::vector<int> |
| 120 | + description: __INLINED__ |
| 121 | + inline: |
| 122 | + arguments: |
| 123 | + first: |
| 124 | + description: the first parameter of the third overload. |
| 125 | + second: |
| 126 | + description: the second parameter of the third overload. |
| 127 | + description: |
| 128 | + - another overloaded member function that takes two parameters. |
| 129 | + return: __OPTIONAL__ |
| 130 | + signature_with_names: void overloaded(const std::string & first, std::vector<int> second) const |
| 131 | +--- |
0 commit comments