diff --git a/.gitignore b/.gitignore index 0680fb1..6b2907b 100644 --- a/.gitignore +++ b/.gitignore @@ -6,5 +6,3 @@ build/ build*/ docs/_site/ docs/Gemfile.lock -docs/libraries -!docs/libraries/index.md diff --git a/docs/_config.yml b/docs/_config.yml index baff4a2..6a29338 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -12,7 +12,7 @@ email: noreply@adobe.com baseurl: /hyde url: "https://opensource.adobe.com/" # the base hostname & protocol for your site repository: adobe/hyde -remote_theme: adobe/hyde-theme@develop +remote_theme: adobe/hyde-theme@v2.0.0 exclude: - "*.sh" - vendor # For Travis-CI (see https://jekyllrb.com/docs/continuous-integration/) diff --git a/docs/libraries/classes.cpp/class_example/color.md b/docs/libraries/classes.cpp/class_example/color.md new file mode 100644 index 0000000..f292d0a --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/color.md @@ -0,0 +1,31 @@ +--- +layout: enumeration +title: color +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - enumeration + inline: + brief: an example enumeration within the class. + description: + - Note that nested classes will not inherit their ownership from the class that contains them, so thus need their own `hyde-owner`. + owner: sean-parent + defined_in_file: classes.cpp + values: + - description: __INLINED__ + inline: + description: + - this is an example description for the `red` value. + name: red + - description: __INLINED__ + inline: + description: + - this is an example description for the `green` value. + name: green + - description: __INLINED__ + inline: + description: + - this is an example description for the `blue` value. + name: blue +--- diff --git a/docs/libraries/classes.cpp/class_example/index.md b/docs/libraries/classes.cpp/class_example/index.md new file mode 100644 index 0000000..4952a53 --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/index.md @@ -0,0 +1,60 @@ +--- +layout: class +title: class_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: an example class that demonstrates what Hyde documents. + owner: fosterbrereton + defined_in_file: classes.cpp + declaration: "\nclass class_example;" + dtor: unspecified + typedefs: + typedef_example: + definition: std::string + description: __INLINED__ + inline: + description: + - a nested `typedef` expression. + using_example: + definition: std::string + description: __INLINED__ + inline: + description: + - a nested `using` expression. + fields: + _deprecated_member: + annotation: + - private + - deprecated("example deprecation message") + description: __INLINED__ + inline: + description: + - a deprecated member variable that contains a message. Apparently this works?! + type: int + _nested: + annotation: + - private + description: __INLINED__ + inline: + description: + - an instance of the nested class example defined earlier. + type: class_example::nested_class_example + _static_member: + description: __INLINED__ + inline: + description: + - static member variable. + type: const int + _x: + annotation: + - private + description: __INLINED__ + inline: + description: + - some variable that holds an integer. + type: int +--- diff --git a/docs/libraries/classes.cpp/class_example/m_class_example.md b/docs/libraries/classes.cpp/class_example/m_class_example.md new file mode 100644 index 0000000..2d9307a --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_class_example.md @@ -0,0 +1,36 @@ +--- +layout: method +title: class_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: _multiple descriptions_ + owner: fosterbrereton + defined_in_file: classes.cpp + is_ctor: true + overloads: + class_example(): + annotation: + - defaulted + description: __INLINED__ + inline: + description: + - default constructor. + signature_with_names: class_example() + explicit class_example(int): + arguments: + - description: __OPTIONAL__ + name: x + type: int + description: __INLINED__ + inline: + arguments: + x: + description: The one integer parameter this routine takes + description: + - an explicit constructor that takes a single `int`. + signature_with_names: explicit class_example(int x) +--- diff --git a/docs/libraries/classes.cpp/class_example/m_deprecated.md b/docs/libraries/classes.cpp/class_example/m_deprecated.md new file mode 100644 index 0000000..d67d433 --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_deprecated.md @@ -0,0 +1,36 @@ +--- +layout: method +title: deprecated +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - deprecated member function. + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + void deprecated(const std::string &, class_example *): + annotation: + - deprecated + arguments: + - description: __OPTIONAL__ + name: first + type: const std::string & + - description: __OPTIONAL__ + name: second + type: class_example * + description: __INLINED__ + inline: + arguments: + first: + description: the first parameter + second: + description: the second parameter + description: + - deprecated member function. + return: __OPTIONAL__ + signature_with_names: void deprecated(const std::string & first, class_example * second) +--- diff --git a/docs/libraries/classes.cpp/class_example/m_deprecated_with_message.md b/docs/libraries/classes.cpp/class_example/m_deprecated_with_message.md new file mode 100644 index 0000000..c73c7aa --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_deprecated_with_message.md @@ -0,0 +1,36 @@ +--- +layout: method +title: deprecated_with_message +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - deprecated member function that contains a compile-time deprecation message. + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + void deprecated_with_message(const std::string &, class_example *): + annotation: + - deprecated("example deprecation message") + arguments: + - description: __OPTIONAL__ + name: s + type: const std::string & + - description: __OPTIONAL__ + name: f + type: class_example * + description: __INLINED__ + inline: + arguments: + f: + description: the second parameter + s: + description: the first parameter + description: + - deprecated member function that contains a compile-time deprecation message. + return: __OPTIONAL__ + signature_with_names: void deprecated_with_message(const std::string & s, class_example * f) +--- diff --git a/docs/libraries/classes.cpp/class_example/m_member_function.md b/docs/libraries/classes.cpp/class_example/m_member_function.md new file mode 100644 index 0000000..45b77e5 --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_member_function.md @@ -0,0 +1,23 @@ +--- +layout: method +title: member_function +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - example member function. + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + int member_function(): + description: __INLINED__ + inline: + description: + - example member function. + return: double the value of `_x`. + return: __OPTIONAL__ + signature_with_names: int member_function() +--- diff --git a/docs/libraries/classes.cpp/class_example/m_member_function_trailing_return_type.md b/docs/libraries/classes.cpp/class_example/m_member_function_trailing_return_type.md new file mode 100644 index 0000000..48794b3 --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_member_function_trailing_return_type.md @@ -0,0 +1,23 @@ +--- +layout: method +title: member_function_trailing_return_type +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - member function with a trailing return type. + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + auto member_function_trailing_return_type() const -> int: + description: __INLINED__ + inline: + description: + - member function with a trailing return type. + return: "\"`_x`\"" + return: __OPTIONAL__ + signature_with_names: auto member_function_trailing_return_type() const -> int +--- diff --git a/docs/libraries/classes.cpp/class_example/m_overloaded.md b/docs/libraries/classes.cpp/class_example/m_overloaded.md new file mode 100644 index 0000000..7d1f246 --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_overloaded.md @@ -0,0 +1,131 @@ +--- +layout: method +title: overloaded +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: _multiple descriptions_ + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + void overloaded(): + annotation: + - deprecated + description: __INLINED__ + inline: + description: + - a deprecated overload that takes zero parameters. + return: __OPTIONAL__ + signature_with_names: void overloaded() + void overloaded(const std::string &): + arguments: + - description: __OPTIONAL__ + name: first + type: const std::string & + description: __INLINED__ + inline: + arguments: + first: + description: the first parameter of the first overload. + brief: A series of overloaded functions. + description: + - an overloaded member function that takes one parameter. + return: __OPTIONAL__ + signature_with_names: void overloaded(const std::string & first) + void overloaded(const std::string &, class_example *, int): + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const std::string & + unnamed: true + - description: __OPTIONAL__ + name: unnamed-1 + type: class_example * + unnamed: true + - description: __OPTIONAL__ + name: unnamed-2 + type: int + unnamed: true + description: __INLINED__ + inline: + description: + - 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. + return: __OPTIONAL__ + signature_with_names: void overloaded(const std::string &, class_example *, int) + void overloaded(const std::string &, class_example *, int, bool, std::size_t): + arguments: + - description: __OPTIONAL__ + name: first + type: const std::string & + - description: __OPTIONAL__ + name: second + type: class_example * + - description: __OPTIONAL__ + name: third + type: int + - description: __OPTIONAL__ + name: fourth + type: bool + - description: __OPTIONAL__ + name: fifth + type: std::size_t + description: __INLINED__ + inline: + arguments: + fifth: + description: the fifth parameter of the fourth overload. + first: + description: the first parameter of the fourth overload. + fourth: + description: the fourth parameter of the fourth overload. + second: + description: the second parameter of the fourth overload. + third: + description: the third parameter of the fourth overload. + description: + - an overloaded member function that takes _five_ parameters. + return: __OPTIONAL__ + signature_with_names: void overloaded(const std::string & first, class_example * second, int third, bool fourth, std::size_t fifth) + void overloaded(const std::string &, const std::string &) volatile: + arguments: + - description: __OPTIONAL__ + name: first + type: const std::string & + - description: __OPTIONAL__ + name: second + type: const std::string & + description: __INLINED__ + inline: + arguments: + first: + description: the first parameter of the second overload. + second: + description: the second parameter of the second overload. + brief: Another brief describing one of the overloaded functions. + description: + - an overloaded member function that takes two parameters. + return: __OPTIONAL__ + signature_with_names: void overloaded(const std::string & first, const std::string & second) volatile + void overloaded(const std::string &, std::vector) const: + arguments: + - description: __OPTIONAL__ + name: first + type: const std::string & + - description: __OPTIONAL__ + name: second + type: std::vector + description: __INLINED__ + inline: + arguments: + first: + description: the first parameter of the third overload. + second: + description: the second parameter of the third overload. + description: + - another overloaded member function that takes two parameters. + return: __OPTIONAL__ + signature_with_names: void overloaded(const std::string & first, std::vector second) const +--- diff --git a/docs/libraries/classes.cpp/class_example/m_static_method.md b/docs/libraries/classes.cpp/class_example/m_static_method.md new file mode 100644 index 0000000..7abfe6b --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_static_method.md @@ -0,0 +1,21 @@ +--- +layout: method +title: static_method +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: static member function. + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + static int static_method(): + description: __OPTIONAL__ + inline: + brief: static member function. + return: Zero. By which I mean `0`. In the sources, this comment is on multiple lines. + return: __OPTIONAL__ + signature_with_names: static int static_method() +--- diff --git a/docs/libraries/classes.cpp/class_example/m_template_member_function.md b/docs/libraries/classes.cpp/class_example/m_template_member_function.md new file mode 100644 index 0000000..51ab427 --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/m_template_member_function.md @@ -0,0 +1,28 @@ +--- +layout: method +title: template_member_function +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: _multiple descriptions_ + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + "template \nvoid template_member_function()": + description: __INLINED__ + inline: + description: + - templatized member function. + return: __OPTIONAL__ + signature_with_names: "template \nvoid template_member_function()" + void template_member_function(): + description: __INLINED__ + inline: + description: + - specialization of the above templatized member function. + return: __OPTIONAL__ + signature_with_names: void template_member_function() +--- diff --git a/docs/libraries/classes.cpp/class_example/nested_class_example/index.md b/docs/libraries/classes.cpp/class_example/nested_class_example/index.md new file mode 100644 index 0000000..83fd50f --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/nested_class_example/index.md @@ -0,0 +1,31 @@ +--- +layout: class +title: nested_class_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: a class definition contained within `example_class`. + description: + - Note that nested classes will not inherit their ownership from the class that contains them, so thus need their own `hyde-owner`. + owner: sean-parent + defined_in_file: classes.cpp + declaration: "\nstruct class_example::nested_class_example;" + ctor: unspecified + dtor: unspecified + fields: + _x: + description: __INLINED__ + inline: + description: + - member field `_x` within the nested class example. + type: int + _y: + description: __INLINED__ + inline: + description: + - member field `_y` within the nested class example. + type: int +--- diff --git a/docs/libraries/classes.cpp/class_example/nested_class_example/m_nested_class_example.md b/docs/libraries/classes.cpp/class_example/nested_class_example/m_nested_class_example.md new file mode 100644 index 0000000..adbbe0a --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/nested_class_example/m_nested_class_example.md @@ -0,0 +1,39 @@ +--- +layout: method +title: nested_class_example +hyde: + owner: __INLINED__ + brief: __OPTIONAL__ + tags: + - method + inline: + owner: sean-parent + defined_in_file: classes.cpp + is_ctor: true + overloads: + nested_class_example(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: nested_class_example() + nested_class_example(class_example::nested_class_example &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: class_example::nested_class_example && + unnamed: true + description: __OPTIONAL__ + signature_with_names: nested_class_example(class_example::nested_class_example &&) + nested_class_example(const class_example::nested_class_example &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const class_example::nested_class_example & + unnamed: true + description: __OPTIONAL__ + signature_with_names: nested_class_example(const class_example::nested_class_example &) +--- diff --git a/docs/libraries/classes.cpp/class_example/nested_class_example/m_~nested_class_example.md b/docs/libraries/classes.cpp/class_example/nested_class_example/m_~nested_class_example.md new file mode 100644 index 0000000..006b19e --- /dev/null +++ b/docs/libraries/classes.cpp/class_example/nested_class_example/m_~nested_class_example.md @@ -0,0 +1,19 @@ +--- +layout: method +title: ~nested_class_example +hyde: + owner: __INLINED__ + brief: __OPTIONAL__ + tags: + - method + inline: + owner: sean-parent + defined_in_file: classes.cpp + is_dtor: true + overloads: + ~nested_class_example(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~nested_class_example() +--- diff --git a/docs/libraries/classes.cpp/index.md b/docs/libraries/classes.cpp/index.md new file mode 100644 index 0000000..ea2ff23 --- /dev/null +++ b/docs/libraries/classes.cpp/index.md @@ -0,0 +1,10 @@ +--- +layout: library +title: classes.cpp +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile +--- diff --git a/docs/libraries/classes.cpp/partial_specialization_.4b7bfe45/index.md b/docs/libraries/classes.cpp/partial_specialization_.4b7bfe45/index.md new file mode 100644 index 0000000..79d1191 --- /dev/null +++ b/docs/libraries/classes.cpp/partial_specialization_.4b7bfe45/index.md @@ -0,0 +1,27 @@ +--- +layout: class +title: partial_specialization_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: an example `int, T` partial specialization + owner: fosterbrereton + defined_in_file: classes.cpp + declaration: "\nclass partial_specialization_example;" + ctor: unspecified + dtor: unspecified + fields: + _first: + annotation: + - private + description: __MISSING__ + type: std::string + _second: + annotation: + - private + description: __MISSING__ + type: T +--- diff --git a/docs/libraries/classes.cpp/partial_specialization_.edfbc14d/index.md b/docs/libraries/classes.cpp/partial_specialization_.edfbc14d/index.md new file mode 100644 index 0000000..c2f1cf0 --- /dev/null +++ b/docs/libraries/classes.cpp/partial_specialization_.edfbc14d/index.md @@ -0,0 +1,27 @@ +--- +layout: class +title: partial_specialization_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: an example template class with a partial specialization. + owner: fosterbrereton + defined_in_file: classes.cpp + declaration: "template \nclass partial_specialization_example;" + ctor: unspecified + dtor: unspecified + fields: + _first: + annotation: + - private + description: __MISSING__ + type: T1 + _second: + annotation: + - private + description: __MISSING__ + type: T2 +--- diff --git a/docs/libraries/classes.cpp/specialization_example3.ed9d8cc7/index.md b/docs/libraries/classes.cpp/specialization_example3.ed9d8cc7/index.md new file mode 100644 index 0000000..97c410f --- /dev/null +++ b/docs/libraries/classes.cpp/specialization_example3.ed9d8cc7/index.md @@ -0,0 +1,30 @@ +--- +layout: class +title: specialization_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: an example `std::int32` specialization + owner: fosterbrereton + defined_in_file: classes.cpp + declaration: "\nstruct specialization_example;" + ctor: unspecified + dtor: unspecified + typedefs: + value_type: + definition: std::int32_t + description: __INLINED__ + inline: + description: + - An example typedef + fields: + _first: + description: __INLINED__ + inline: + description: + - An example field used in `as_tuple` + type: specialization_example::value_type +--- diff --git a/docs/libraries/classes.cpp/specialization_example3.ed9d8cc7/m_as_tuple.md b/docs/libraries/classes.cpp/specialization_example3.ed9d8cc7/m_as_tuple.md new file mode 100644 index 0000000..6773f17 --- /dev/null +++ b/docs/libraries/classes.cpp/specialization_example3.ed9d8cc7/m_as_tuple.md @@ -0,0 +1,23 @@ +--- +layout: method +title: as_tuple +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - An example function + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + constexpr tuple as_tuple() const: + description: __INLINED__ + inline: + description: + - An example function + return: a tuple of the fields of this class + return: __OPTIONAL__ + signature_with_names: constexpr tuple as_tuple() const +--- diff --git a/docs/libraries/classes.cpp/specialization_example3CT3E/index.md b/docs/libraries/classes.cpp/specialization_example3CT3E/index.md new file mode 100644 index 0000000..e08502f --- /dev/null +++ b/docs/libraries/classes.cpp/specialization_example3CT3E/index.md @@ -0,0 +1,16 @@ +--- +layout: class +title: specialization_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: an example template class with some specializations + owner: fosterbrereton + defined_in_file: classes.cpp + declaration: "template \nstruct specialization_example;" + ctor: unspecified + dtor: unspecified +--- diff --git a/docs/libraries/classes.cpp/specialization_example3CT3E/m_as_tuple.md b/docs/libraries/classes.cpp/specialization_example3CT3E/m_as_tuple.md new file mode 100644 index 0000000..61db89d --- /dev/null +++ b/docs/libraries/classes.cpp/specialization_example3CT3E/m_as_tuple.md @@ -0,0 +1,17 @@ +--- +layout: method +title: as_tuple +hyde: + owner: __INLINED__ + brief: __MISSING__ + tags: + - method + inline: + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + constexpr auto as_tuple() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: constexpr auto as_tuple() const +--- diff --git a/docs/libraries/classes.cpp/specialization_example3Cfloat3E/index.md b/docs/libraries/classes.cpp/specialization_example3Cfloat3E/index.md new file mode 100644 index 0000000..6dfa0c2 --- /dev/null +++ b/docs/libraries/classes.cpp/specialization_example3Cfloat3E/index.md @@ -0,0 +1,27 @@ +--- +layout: class +title: specialization_example +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: an example `float` specialization + owner: fosterbrereton + defined_in_file: classes.cpp + declaration: "\nstruct specialization_example;" + ctor: unspecified + dtor: unspecified + typedefs: + value_type: + definition: float + description: __MISSING__ + fields: + _first: + description: __INLINED__ + inline: + description: + - An example field used in `as_tuple` + type: specialization_example::value_type +--- diff --git a/docs/libraries/classes.cpp/specialization_example3Cfloat3E/m_as_tuple.md b/docs/libraries/classes.cpp/specialization_example3Cfloat3E/m_as_tuple.md new file mode 100644 index 0000000..57bb916 --- /dev/null +++ b/docs/libraries/classes.cpp/specialization_example3Cfloat3E/m_as_tuple.md @@ -0,0 +1,17 @@ +--- +layout: method +title: as_tuple +hyde: + owner: __INLINED__ + brief: __MISSING__ + tags: + - method + inline: + owner: fosterbrereton + defined_in_file: classes.cpp + overloads: + constexpr tuple as_tuple() const: + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: constexpr tuple as_tuple() const +--- diff --git a/docs/libraries/comments.cpp/compiler_generated/index.md b/docs/libraries/comments.cpp/compiler_generated/index.md new file mode 100644 index 0000000..6213c90 --- /dev/null +++ b/docs/libraries/comments.cpp/compiler_generated/index.md @@ -0,0 +1,15 @@ +--- +layout: class +title: compiler_generated +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: Sample class intended to exhibit docs for compiler-generated routines + owner: fosterbrereton + defined_in_file: comments.cpp + declaration: "\nstruct compiler_generated;" + dtor: unspecified +--- diff --git a/docs/libraries/comments.cpp/compiler_generated/m_assign.md b/docs/libraries/comments.cpp/compiler_generated/m_assign.md new file mode 100644 index 0000000..cad08ce --- /dev/null +++ b/docs/libraries/comments.cpp/compiler_generated/m_assign.md @@ -0,0 +1,26 @@ +--- +layout: method +title: assign +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - This definition will force the compiler to auto-generate this class' assignment operator. + owner: fosterbrereton + defined_in_file: comments.cpp + overloads: + void assign(const compiler_generated &): + arguments: + - description: __OPTIONAL__ + name: rhs + type: const compiler_generated & + description: __INLINED__ + inline: + description: + - This definition will force the compiler to auto-generate this class' assignment operator. + return: __OPTIONAL__ + signature_with_names: void assign(const compiler_generated & rhs) +--- diff --git a/docs/libraries/comments.cpp/compiler_generated/m_compiler_generated.md b/docs/libraries/comments.cpp/compiler_generated/m_compiler_generated.md new file mode 100644 index 0000000..55c9961 --- /dev/null +++ b/docs/libraries/comments.cpp/compiler_generated/m_compiler_generated.md @@ -0,0 +1,29 @@ +--- +layout: method +title: compiler_generated +hyde: + owner: __INLINED__ + brief: __OPTIONAL__ + tags: + - method + inline: + owner: fosterbrereton + defined_in_file: comments.cpp + is_ctor: true + overloads: + compiler_generated(): + annotation: + - deleted + description: __OPTIONAL__ + signature_with_names: compiler_generated() + compiler_generated(const compiler_generated &): + annotation: + - defaulted + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const compiler_generated & + unnamed: true + description: __OPTIONAL__ + signature_with_names: compiler_generated(const compiler_generated &) +--- diff --git a/docs/libraries/comments.cpp/compiler_generated/m_operator3D.md b/docs/libraries/comments.cpp/compiler_generated/m_operator3D.md new file mode 100644 index 0000000..fff9f0d --- /dev/null +++ b/docs/libraries/comments.cpp/compiler_generated/m_operator3D.md @@ -0,0 +1,24 @@ +--- +layout: method +title: operator= +hyde: + owner: __INLINED__ + brief: __OPTIONAL__ + tags: + - method + inline: + owner: fosterbrereton + defined_in_file: comments.cpp + overloads: + constexpr compiler_generated & operator=(const compiler_generated &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const compiler_generated & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: constexpr compiler_generated & operator=(const compiler_generated &) +--- diff --git a/docs/libraries/comments.cpp/f_template_function.md b/docs/libraries/comments.cpp/f_template_function.md new file mode 100644 index 0000000..0f99544 --- /dev/null +++ b/docs/libraries/comments.cpp/f_template_function.md @@ -0,0 +1,20 @@ +--- +layout: function +title: template_function +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: some template function + defined_in_file: comments.cpp + overloads: + "template \nT template_function()": + description: __OPTIONAL__ + inline: + brief: some template function + return: an instance of type `T` + return: __OPTIONAL__ + signature_with_names: "template \nT template_function()" +--- diff --git a/docs/libraries/comments.cpp/index.md b/docs/libraries/comments.cpp/index.md new file mode 100644 index 0000000..d755142 --- /dev/null +++ b/docs/libraries/comments.cpp/index.md @@ -0,0 +1,10 @@ +--- +layout: library +title: comments.cpp +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile +--- diff --git a/docs/libraries/comments.cpp/some_other_struct/index.md b/docs/libraries/comments.cpp/some_other_struct/index.md new file mode 100644 index 0000000..9527416 --- /dev/null +++ b/docs/libraries/comments.cpp/some_other_struct/index.md @@ -0,0 +1,17 @@ +--- +layout: class +title: some_other_struct +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - class + inline: + brief: This is a sample brief for `some_other_struct` + description: + - Notice how many of the comments for this structure are inherited from its superclass. + defined_in_file: comments.cpp + declaration: "\nstruct some_other_struct;" + ctor: unspecified + dtor: unspecified +--- diff --git a/docs/libraries/comments.cpp/some_other_struct/m_operator3D.md b/docs/libraries/comments.cpp/some_other_struct/m_operator3D.md new file mode 100644 index 0000000..c7311fe --- /dev/null +++ b/docs/libraries/comments.cpp/some_other_struct/m_operator3D.md @@ -0,0 +1,33 @@ +--- +layout: method +title: operator= +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: comments.cpp + overloads: + some_other_struct & operator=(const some_other_struct &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const some_other_struct & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: some_other_struct & operator=(const some_other_struct &) + some_other_struct & operator=(some_other_struct &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: some_other_struct && + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: some_other_struct & operator=(some_other_struct &&) +--- diff --git a/docs/libraries/comments.cpp/some_other_struct/m_some_other_struct.md b/docs/libraries/comments.cpp/some_other_struct/m_some_other_struct.md new file mode 100644 index 0000000..8f3d064 --- /dev/null +++ b/docs/libraries/comments.cpp/some_other_struct/m_some_other_struct.md @@ -0,0 +1,32 @@ +--- +layout: method +title: some_other_struct +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: comments.cpp + is_ctor: true + overloads: + some_other_struct(const some_other_struct &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const some_other_struct & + unnamed: true + description: __OPTIONAL__ + signature_with_names: some_other_struct(const some_other_struct &) + some_other_struct(some_other_struct &&): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: some_other_struct && + unnamed: true + description: __OPTIONAL__ + signature_with_names: some_other_struct(some_other_struct &&) +--- diff --git a/docs/libraries/comments.cpp/some_other_struct/m_virtual_function.md b/docs/libraries/comments.cpp/some_other_struct/m_virtual_function.md new file mode 100644 index 0000000..0c1eb1e --- /dev/null +++ b/docs/libraries/comments.cpp/some_other_struct/m_virtual_function.md @@ -0,0 +1,21 @@ +--- +layout: method +title: virtual_function +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - A virtual function that intends to be overridden. + defined_in_file: comments.cpp + overloads: + void virtual_function(): + description: __INLINED__ + inline: + description: + - A virtual function that intends to be overridden. + return: __OPTIONAL__ + signature_with_names: void virtual_function() +--- diff --git a/docs/libraries/comments.cpp/some_other_struct/m_~some_other_struct.md b/docs/libraries/comments.cpp/some_other_struct/m_~some_other_struct.md new file mode 100644 index 0000000..e736566 --- /dev/null +++ b/docs/libraries/comments.cpp/some_other_struct/m_~some_other_struct.md @@ -0,0 +1,17 @@ +--- +layout: method +title: ~some_other_struct +hyde: + owner: __OPTIONAL__ + brief: __OPTIONAL__ + tags: + - method + defined_in_file: comments.cpp + is_dtor: true + overloads: + ~some_other_struct(): + annotation: + - implicit + description: __OPTIONAL__ + signature_with_names: ~some_other_struct() +--- diff --git a/docs/libraries/comments.cpp/some_struct/index.md b/docs/libraries/comments.cpp/some_struct/index.md new file mode 100644 index 0000000..55e429c --- /dev/null +++ b/docs/libraries/comments.cpp/some_struct/index.md @@ -0,0 +1,27 @@ +--- +layout: class +title: some_struct +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - class + inline: + brief: This is a sample brief. + description: + - An example struct from which these commands will hang. + owner: fosterbrereton + par: header This is a sample paragraph. + see: "[Slides](https://llvm.org/devmtg/2012-11/Gribenko_CommentParsing.pdf) from an LLVM dev meeting chat on the comment parsing feature" + warning: This is a sample warning. + defined_in_file: comments.cpp + declaration: "\nstruct some_struct;" + ctor: unspecified + fields: + _x: + description: __INLINED__ + inline: + description: + - A trailing comment that documents `_x`. + type: int +--- diff --git a/docs/libraries/comments.cpp/some_struct/m_operator3D.md b/docs/libraries/comments.cpp/some_struct/m_operator3D.md new file mode 100644 index 0000000..6c12a64 --- /dev/null +++ b/docs/libraries/comments.cpp/some_struct/m_operator3D.md @@ -0,0 +1,24 @@ +--- +layout: method +title: operator= +hyde: + owner: __INLINED__ + brief: __OPTIONAL__ + tags: + - method + inline: + owner: fosterbrereton + defined_in_file: comments.cpp + overloads: + some_struct & operator=(const some_struct &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const some_struct & + unnamed: true + description: __OPTIONAL__ + return: __OPTIONAL__ + signature_with_names: some_struct & operator=(const some_struct &) +--- diff --git a/docs/libraries/comments.cpp/some_struct/m_some_function.md b/docs/libraries/comments.cpp/some_struct/m_some_function.md new file mode 100644 index 0000000..ac4dca4 --- /dev/null +++ b/docs/libraries/comments.cpp/some_struct/m_some_function.md @@ -0,0 +1,48 @@ +--- +layout: method +title: some_function +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: A function that does a thing, and does it well. + owner: fosterbrereton + defined_in_file: comments.cpp + overloads: + int some_function(int, int &, int &): + arguments: + - description: __OPTIONAL__ + name: input + type: int + - description: __OPTIONAL__ + name: input_output + type: int & + - description: __OPTIONAL__ + name: output + type: int & + description: __INLINED__ + inline: + arguments: + input: + description: an input parameter + direction: in + input_output: + description: a bidirectional parameter + direction: inout + output: + description: an output parameter + direction: out + brief: A function that does a thing, and does it well. + description: + - This is a longer description of this function that does things as well as it does. Notice how long this comment is! So impressive. 💥 + post: An example postcondition. + pre: An example precondition. + return: Some additional value. + throw: "`std::runtime_error` if the function actually _can't_ do the thing. Sorry!" + todo: This really could use some cleanup. Although, its implementation doesn't exist... + warning: This function may be very expensive to run. Do not call it inside a loop. + return: __OPTIONAL__ + signature_with_names: int some_function(int input, int & input_output, int & output) +--- diff --git a/docs/libraries/comments.cpp/some_struct/m_some_struct.md b/docs/libraries/comments.cpp/some_struct/m_some_struct.md new file mode 100644 index 0000000..2434053 --- /dev/null +++ b/docs/libraries/comments.cpp/some_struct/m_some_struct.md @@ -0,0 +1,24 @@ +--- +layout: method +title: some_struct +hyde: + owner: __INLINED__ + brief: __OPTIONAL__ + tags: + - method + inline: + owner: fosterbrereton + defined_in_file: comments.cpp + is_ctor: true + overloads: + some_struct(const some_struct &): + annotation: + - implicit + arguments: + - description: __OPTIONAL__ + name: unnamed-0 + type: const some_struct & + unnamed: true + description: __OPTIONAL__ + signature_with_names: some_struct(const some_struct &) +--- diff --git a/docs/libraries/comments.cpp/some_struct/m_virtual_function.md b/docs/libraries/comments.cpp/some_struct/m_virtual_function.md new file mode 100644 index 0000000..79c2c30 --- /dev/null +++ b/docs/libraries/comments.cpp/some_struct/m_virtual_function.md @@ -0,0 +1,22 @@ +--- +layout: method +title: virtual_function +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - A virtual function that intends to be overridden. + owner: fosterbrereton + defined_in_file: comments.cpp + overloads: + void virtual_function(): + description: __INLINED__ + inline: + description: + - A virtual function that intends to be overridden. + return: __OPTIONAL__ + signature_with_names: void virtual_function() +--- diff --git a/docs/libraries/comments.cpp/some_struct/m_~some_struct.md b/docs/libraries/comments.cpp/some_struct/m_~some_struct.md new file mode 100644 index 0000000..6f98d51 --- /dev/null +++ b/docs/libraries/comments.cpp/some_struct/m_~some_struct.md @@ -0,0 +1,19 @@ +--- +layout: method +title: ~some_struct +hyde: + owner: __INLINED__ + brief: __OPTIONAL__ + tags: + - method + inline: + owner: fosterbrereton + defined_in_file: comments.cpp + is_dtor: true + overloads: + ~some_struct(): + annotation: + - deleted + description: __OPTIONAL__ + signature_with_names: ~some_struct() +--- diff --git a/docs/libraries/enums.cpp/color_channel.md b/docs/libraries/enums.cpp/color_channel.md new file mode 100644 index 0000000..c5e9e71 --- /dev/null +++ b/docs/libraries/enums.cpp/color_channel.md @@ -0,0 +1,29 @@ +--- +layout: enumeration +title: color_channel +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - enumeration + inline: + brief: An example typed enumeration with three values. + owner: fosterbrereton + defined_in_file: enums.cpp + values: + - description: __INLINED__ + inline: + description: + - Red commentary + name: red + - description: __INLINED__ + inline: + description: + - Green commentary. Note this enum has a pre-set value. + name: green + - description: __INLINED__ + inline: + description: + - Blue commentary + name: blue +--- diff --git a/docs/libraries/enums.cpp/index.md b/docs/libraries/enums.cpp/index.md new file mode 100644 index 0000000..920f897 --- /dev/null +++ b/docs/libraries/enums.cpp/index.md @@ -0,0 +1,10 @@ +--- +layout: library +title: enums.cpp +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile +--- diff --git a/docs/libraries/enums.cpp/untyped.md b/docs/libraries/enums.cpp/untyped.md new file mode 100644 index 0000000..8762713 --- /dev/null +++ b/docs/libraries/enums.cpp/untyped.md @@ -0,0 +1,29 @@ +--- +layout: enumeration +title: untyped +hyde: + owner: __INLINED__ + brief: __INLINED__ + tags: + - enumeration + inline: + brief: An example untyped enumeration with three values. + owner: fosterbrereton + defined_in_file: enums.cpp + values: + - description: __INLINED__ + inline: + description: + - Apple commentary + name: apple + - description: __INLINED__ + inline: + description: + - Orange commentary + name: orange + - description: __INLINED__ + inline: + description: + - Banana commentary + name: banana +--- diff --git a/docs/libraries/functions.cpp/f_binary_function_example.md b/docs/libraries/functions.cpp/f_binary_function_example.md new file mode 100644 index 0000000..5675f95 --- /dev/null +++ b/docs/libraries/functions.cpp/f_binary_function_example.md @@ -0,0 +1,34 @@ +--- +layout: function +title: binary_function_example +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - an example binary function. + defined_in_file: functions.cpp + overloads: + int binary_function_example(int, int): + arguments: + - description: __OPTIONAL__ + name: first + type: int + - description: __OPTIONAL__ + name: second + type: int + description: __INLINED__ + inline: + arguments: + first: + description: the first input + second: + description: the second input + description: + - an example binary function. + return: The sum of the two input parameters. + return: __OPTIONAL__ + signature_with_names: int binary_function_example(int first, int second) +--- diff --git a/docs/libraries/functions.cpp/f_nullary_function_example.md b/docs/libraries/functions.cpp/f_nullary_function_example.md new file mode 100644 index 0000000..9063291 --- /dev/null +++ b/docs/libraries/functions.cpp/f_nullary_function_example.md @@ -0,0 +1,22 @@ +--- +layout: function +title: nullary_function_example +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - an example nullary function. + defined_in_file: functions.cpp + overloads: + int nullary_function_example(): + description: __INLINED__ + inline: + description: + - an example nullary function. + return: "`0`" + return: __OPTIONAL__ + signature_with_names: int nullary_function_example() +--- diff --git a/docs/libraries/functions.cpp/f_overloaded.md b/docs/libraries/functions.cpp/f_overloaded.md new file mode 100644 index 0000000..72f33df --- /dev/null +++ b/docs/libraries/functions.cpp/f_overloaded.md @@ -0,0 +1,73 @@ +--- +layout: function +title: overloaded +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: functions.cpp + overloads: + auto overloaded(int) -> float: + arguments: + - description: __OPTIONAL__ + name: first + type: int + description: __INLINED__ + inline: + arguments: + first: + description: the first input parameter + description: + - an example unary overloaded function + return: "`first`" + return: __OPTIONAL__ + signature_with_names: auto overloaded(int first) -> float + auto overloaded(int, int) -> double: + arguments: + - description: __OPTIONAL__ + name: first + type: int + - description: __OPTIONAL__ + name: second + type: int + description: __INLINED__ + inline: + arguments: + first: + description: the first input parameter + second: + description: the second input parameter + description: + - an example binary overloaded function + return: the product of `first` and `second` + return: __OPTIONAL__ + signature_with_names: auto overloaded(int first, int second) -> double + auto overloaded(int, int, int) -> float: + arguments: + - description: __OPTIONAL__ + name: first + type: int + - description: __OPTIONAL__ + name: second + type: int + - description: __OPTIONAL__ + name: third + type: int + description: __INLINED__ + inline: + arguments: + first: + description: the first input parameter + second: + description: the second input parameter + third: + description: the third input parameter + description: + - an example tertiary overloaded function + return: the product of `first`, `second`, and `third` + return: __OPTIONAL__ + signature_with_names: auto overloaded(int first, int second, int third) -> float +--- diff --git a/docs/libraries/functions.cpp/f_static_auto_function_example.md b/docs/libraries/functions.cpp/f_static_auto_function_example.md new file mode 100644 index 0000000..0a32a61 --- /dev/null +++ b/docs/libraries/functions.cpp/f_static_auto_function_example.md @@ -0,0 +1,22 @@ +--- +layout: function +title: static_auto_function_example +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - an example static function with `auto` return type + defined_in_file: functions.cpp + overloads: + static int static_auto_function_example(): + description: __INLINED__ + inline: + description: + - an example static function with `auto` return type + return: "`0`" + return: __OPTIONAL__ + signature_with_names: static int static_auto_function_example() +--- diff --git a/docs/libraries/functions.cpp/f_static_function_example.md b/docs/libraries/functions.cpp/f_static_function_example.md new file mode 100644 index 0000000..4ea80db --- /dev/null +++ b/docs/libraries/functions.cpp/f_static_function_example.md @@ -0,0 +1,22 @@ +--- +layout: function +title: static_function_example +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - an example static function + defined_in_file: functions.cpp + overloads: + static int static_function_example(): + description: __INLINED__ + inline: + description: + - an example static function + return: "`0`" + return: __OPTIONAL__ + signature_with_names: static int static_function_example() +--- diff --git a/docs/libraries/functions.cpp/f_static_trailing_type_function_example.md b/docs/libraries/functions.cpp/f_static_trailing_type_function_example.md new file mode 100644 index 0000000..1239d6e --- /dev/null +++ b/docs/libraries/functions.cpp/f_static_trailing_type_function_example.md @@ -0,0 +1,22 @@ +--- +layout: function +title: static_trailing_type_function_example +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - an example static function with trailing return type + defined_in_file: functions.cpp + overloads: + static auto static_trailing_type_function_example() -> int: + description: __INLINED__ + inline: + description: + - an example static function with trailing return type + return: "`0`" + return: __OPTIONAL__ + signature_with_names: static auto static_trailing_type_function_example() -> int +--- diff --git a/docs/libraries/functions.cpp/f_template_function_example.md b/docs/libraries/functions.cpp/f_template_function_example.md new file mode 100644 index 0000000..fa8e439 --- /dev/null +++ b/docs/libraries/functions.cpp/f_template_function_example.md @@ -0,0 +1,29 @@ +--- +layout: function +title: template_function_example +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: functions.cpp + overloads: + int template_function_example(): + description: __INLINED__ + inline: + description: + - an example specialization of the template function example + return: Forty-two + return: __OPTIONAL__ + signature_with_names: int template_function_example() + "template \nT template_function_example()": + description: __INLINED__ + inline: + description: + - an example template function, deleted by default + return: Not applicable, seeing that the default definition has been deleted. + return: __OPTIONAL__ + signature_with_names: "template \nT template_function_example()" +--- diff --git a/docs/libraries/functions.cpp/index.md b/docs/libraries/functions.cpp/index.md new file mode 100644 index 0000000..7053fec --- /dev/null +++ b/docs/libraries/functions.cpp/index.md @@ -0,0 +1,10 @@ +--- +layout: library +title: functions.cpp +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile +--- diff --git a/docs/libraries/index.md b/docs/libraries/index.md new file mode 100644 index 0000000..f9c73cb --- /dev/null +++ b/docs/libraries/index.md @@ -0,0 +1,13 @@ +--- +layout: library +title: Hyde Sample Docs +hyde: + owner: fosterbrereton + brief: Sample Hyde Documentation + tags: + - library + library-type: library + icon: book + short_title: Sample Docs + tab: Docs +--- diff --git a/docs/libraries/namespaces.cpp/f_function.md b/docs/libraries/namespaces.cpp/f_function.md new file mode 100644 index 0000000..288acad --- /dev/null +++ b/docs/libraries/namespaces.cpp/f_function.md @@ -0,0 +1,24 @@ +--- +layout: function +title: function +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: _multiple descriptions_ + defined_in_file: namespaces.cpp + overloads: + void function(): + description: __INLINED__ + inline: + description: + - function contained within namespace `foo`. + return: __OPTIONAL__ + signature_with_names: void function() + namespace: + - foo + - bar + - baz +--- diff --git a/docs/libraries/namespaces.cpp/index.md b/docs/libraries/namespaces.cpp/index.md new file mode 100644 index 0000000..3a52819 --- /dev/null +++ b/docs/libraries/namespaces.cpp/index.md @@ -0,0 +1,10 @@ +--- +layout: library +title: namespaces.cpp +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile +--- diff --git a/docs/libraries/point.cpp/index.md b/docs/libraries/point.cpp/index.md new file mode 100644 index 0000000..07c9f2f --- /dev/null +++ b/docs/libraries/point.cpp/index.md @@ -0,0 +1,10 @@ +--- +layout: library +title: point.cpp +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile +--- diff --git a/docs/libraries/point.cpp/point3CT3E/f_operator-.md b/docs/libraries/point.cpp/point3CT3E/f_operator-.md new file mode 100644 index 0000000..e0c343c --- /dev/null +++ b/docs/libraries/point.cpp/point3CT3E/f_operator-.md @@ -0,0 +1,34 @@ +--- +layout: function +title: operator- +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - Subtraction operator. + defined_in_file: point.cpp + overloads: + constexpr point operator-(const point &, const point &): + arguments: + - description: __OPTIONAL__ + name: a + type: const point & + - description: __OPTIONAL__ + name: b + type: const point & + description: __INLINED__ + inline: + arguments: + a: + description: The point to be subtracted from. + b: + description: The point to subtract. + description: + - Subtraction operator. + return: A new point whose axis values are subtractions of the two inputs' axis values. + return: __OPTIONAL__ + signature_with_names: constexpr point operator-(const point & a, const point & b) +--- diff --git a/docs/libraries/point.cpp/point3CT3E/f_operator213D.md b/docs/libraries/point.cpp/point3CT3E/f_operator213D.md new file mode 100644 index 0000000..bdbbe91 --- /dev/null +++ b/docs/libraries/point.cpp/point3CT3E/f_operator213D.md @@ -0,0 +1,29 @@ +--- +layout: function +title: operator!= +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - Inequality operator. + defined_in_file: point.cpp + overloads: + constexpr bool operator!=(const point &, const point &): + arguments: + - description: __OPTIONAL__ + name: a + type: const point & + - description: __OPTIONAL__ + name: b + type: const point & + description: __INLINED__ + inline: + description: + - Inequality operator. + return: "`true` iff the two points' `x` or `y` coordinates are memberwise inequal." + return: __OPTIONAL__ + signature_with_names: constexpr bool operator!=(const point & a, const point & b) +--- diff --git a/docs/libraries/point.cpp/point3CT3E/f_operator3D3D.md b/docs/libraries/point.cpp/point3CT3E/f_operator3D3D.md new file mode 100644 index 0000000..1a0a572 --- /dev/null +++ b/docs/libraries/point.cpp/point3CT3E/f_operator3D3D.md @@ -0,0 +1,29 @@ +--- +layout: function +title: operator== +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - function + inline: + brief: + - Equality operator. + defined_in_file: point.cpp + overloads: + constexpr bool operator==(const point &, const point &): + arguments: + - description: __OPTIONAL__ + name: a + type: const point & + - description: __OPTIONAL__ + name: b + type: const point & + description: __INLINED__ + inline: + description: + - Equality operator. + return: "`true` iff the two points' `x` and `y` coordinates are memberwise equal." + return: __OPTIONAL__ + signature_with_names: constexpr bool operator==(const point & a, const point & b) +--- diff --git a/docs/libraries/point.cpp/point3CT3E/index.md b/docs/libraries/point.cpp/point3CT3E/index.md new file mode 100644 index 0000000..6f827cc --- /dev/null +++ b/docs/libraries/point.cpp/point3CT3E/index.md @@ -0,0 +1,27 @@ +--- +layout: class +title: point +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - class + inline: + brief: An example point class + defined_in_file: point.cpp + declaration: "template \nstruct point;" + dtor: unspecified + fields: + x: + description: __INLINED__ + inline: + description: + - The `x` coordinate of the point. + type: T + y: + description: __INLINED__ + inline: + description: + - The `y` coordinate of the point. + type: T +--- diff --git a/docs/libraries/point.cpp/point3CT3E/m_operator-3D.md b/docs/libraries/point.cpp/point3CT3E/m_operator-3D.md new file mode 100644 index 0000000..85cec7d --- /dev/null +++ b/docs/libraries/point.cpp/point3CT3E/m_operator-3D.md @@ -0,0 +1,29 @@ +--- +layout: method +title: operator-= +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - Subtraction-assignment operator. + defined_in_file: point.cpp + overloads: + constexpr point & operator-=(const point &): + arguments: + - description: __OPTIONAL__ + name: a + type: const point & + description: __INLINED__ + inline: + arguments: + a: + description: The point to subtract from this point + description: + - Subtraction-assignment operator. + return: A reference to `this`. + return: __OPTIONAL__ + signature_with_names: constexpr point & operator-=(const point & a) +--- diff --git a/docs/libraries/point.cpp/point3CT3E/m_origin.md b/docs/libraries/point.cpp/point3CT3E/m_origin.md new file mode 100644 index 0000000..aa5f8f2 --- /dev/null +++ b/docs/libraries/point.cpp/point3CT3E/m_origin.md @@ -0,0 +1,22 @@ +--- +layout: method +title: origin +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - method + inline: + brief: + - A static routine that returns the origin point. + defined_in_file: point.cpp + overloads: + constexpr static auto origin(): + description: __INLINED__ + inline: + description: + - A static routine that returns the origin point. + return: The point `(0, 0)` + return: __OPTIONAL__ + signature_with_names: constexpr static auto origin() +--- diff --git a/docs/libraries/point.cpp/point3CT3E/m_point3CT3E.md b/docs/libraries/point.cpp/point3CT3E/m_point3CT3E.md new file mode 100644 index 0000000..508d7be --- /dev/null +++ b/docs/libraries/point.cpp/point3CT3E/m_point3CT3E.md @@ -0,0 +1,40 @@ +--- +layout: method +title: point +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - method + inline: + brief: _multiple descriptions_ + defined_in_file: point.cpp + is_ctor: true + overloads: + point(): + annotation: + - defaulted + description: __INLINED__ + inline: + description: + - Default constructor of default definition. + signature_with_names: point() + point(T, T): + arguments: + - description: __OPTIONAL__ + name: _x + type: T + - description: __OPTIONAL__ + name: _y + type: T + description: __INLINED__ + inline: + arguments: + _x: + description: The `x` coordinate to sink. + _y: + description: The `y` coordinate to sink. + description: + - Value-based constructor that takes `x` and `y` values and sinks them into place. + signature_with_names: point(T _x, T _y) +--- diff --git a/docs/libraries/typedef_and_alias.cpp/index.md b/docs/libraries/typedef_and_alias.cpp/index.md new file mode 100644 index 0000000..7d93f94 --- /dev/null +++ b/docs/libraries/typedef_and_alias.cpp/index.md @@ -0,0 +1,41 @@ +--- +layout: library +title: typedef_and_alias.cpp +hyde: + owner: __MISSING__ + brief: __MISSING__ + tags: + - sourcefile + library-type: sourcefile + typedefs: + typedef_example: + definition: int + description: __INLINED__ + inline: + description: + - Example typedef expression whose underlying type is `int`. + typedef_full_specialization_example: + definition: using_partial_specialization_example + description: __INLINED__ + inline: + description: + - Using typedef to define another full specialization of the above partial specialization + using_example: + definition: int + description: __INLINED__ + inline: + description: + - Example using expression whose underlying type is `int`. + using_full_specialization_example: + definition: using_partial_specialization_example + description: __INLINED__ + inline: + description: + - Full specialization of the above partial specialization + using_partial_specialization_example: + definition: template_example + description: __INLINED__ + inline: + description: + - Partial specialization of the above `template_example` template +--- diff --git a/docs/libraries/typedef_and_alias.cpp/template_example3CT2C20U3E/index.md b/docs/libraries/typedef_and_alias.cpp/template_example3CT2C20U3E/index.md new file mode 100644 index 0000000..3da393a --- /dev/null +++ b/docs/libraries/typedef_and_alias.cpp/template_example3CT2C20U3E/index.md @@ -0,0 +1,28 @@ +--- +layout: class +title: template_example +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - class + inline: + brief: Example class with two type definitions + defined_in_file: typedef_and_alias.cpp + declaration: "template \nstruct template_example;" + ctor: unspecified + dtor: unspecified + typedefs: + typedef_from_T: + definition: T + description: __INLINED__ + inline: + description: + - Type derived from the first template parameter. + using_from_U: + definition: U + description: __INLINED__ + inline: + description: + - Type derived from the second template parameter. +--- diff --git a/docs/libraries/typedef_and_alias.cpp/template_example_instantiator/index.md b/docs/libraries/typedef_and_alias.cpp/template_example_instantiator/index.md new file mode 100644 index 0000000..1bb0979 --- /dev/null +++ b/docs/libraries/typedef_and_alias.cpp/template_example_instantiator/index.md @@ -0,0 +1,28 @@ +--- +layout: class +title: template_example_instantiator +hyde: + owner: __MISSING__ + brief: __INLINED__ + tags: + - class + inline: + brief: Example struct that leverages type aliases defined above. + defined_in_file: typedef_and_alias.cpp + declaration: "\nstruct template_example_instantiator;" + ctor: unspecified + dtor: unspecified + typedefs: + typedef_full_specialization_example: + definition: using_partial_specialization_example + description: __INLINED__ + inline: + description: + - Example partial specialization using `typedef` + using_full_specialization_example: + definition: using_partial_specialization_example + description: __INLINED__ + inline: + description: + - Example full specialization +---