Skip to content

Commit 504802e

Browse files
fosterbreretonfosterbrereton
committed
update sample docs
1 parent 3c86c1a commit 504802e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1783
-3
lines changed

‎.gitignore

-2
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,3 @@ build/
66
build*/
77
docs/_site/
88
docs/Gemfile.lock
9-
docs/libraries
10-
!docs/libraries/index.md

‎docs/_config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ email: [email protected]
1212
baseurl: /hyde
1313
url: "https://opensource.adobe.com/" # the base hostname & protocol for your site
1414
repository: adobe/hyde
15-
remote_theme: adobe/hyde-theme@develop
15+
remote_theme: adobe/hyde-theme@v2.0.0
1616
exclude:
1717
- "*.sh"
1818
- vendor # For Travis-CI (see https://jekyllrb.com/docs/continuous-integration/)

‎docs/libraries/classes.cpp/class_example/color.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: enumeration
3+
title: color
4+
hyde:
5+
owner: __INLINED__
6+
brief: __INLINED__
7+
tags:
8+
- enumeration
9+
inline:
10+
brief: an example enumeration within the class.
11+
description:
12+
- Note that nested classes will not inherit their ownership from the class that contains them, so thus need their own `hyde-owner`.
13+
owner: sean-parent
14+
defined_in_file: classes.cpp
15+
values:
16+
- description: __INLINED__
17+
inline:
18+
description:
19+
- this is an example description for the `red` value.
20+
name: red
21+
- description: __INLINED__
22+
inline:
23+
description:
24+
- this is an example description for the `green` value.
25+
name: green
26+
- description: __INLINED__
27+
inline:
28+
description:
29+
- this is an example description for the `blue` value.
30+
name: blue
31+
---

‎docs/libraries/classes.cpp/class_example/index.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
layout: class
3+
title: class_example
4+
hyde:
5+
owner: __INLINED__
6+
brief: __INLINED__
7+
tags:
8+
- class
9+
inline:
10+
brief: an example class that demonstrates what Hyde documents.
11+
owner: fosterbrereton
12+
defined_in_file: classes.cpp
13+
declaration: "\nclass class_example;"
14+
dtor: unspecified
15+
typedefs:
16+
typedef_example:
17+
definition: std::string
18+
description: __INLINED__
19+
inline:
20+
description:
21+
- a nested `typedef` expression.
22+
using_example:
23+
definition: std::string
24+
description: __INLINED__
25+
inline:
26+
description:
27+
- a nested `using` expression.
28+
fields:
29+
_deprecated_member:
30+
annotation:
31+
- private
32+
- deprecated("example deprecation message")
33+
description: __INLINED__
34+
inline:
35+
description:
36+
- a deprecated member variable that contains a message. Apparently this works?!
37+
type: int
38+
_nested:
39+
annotation:
40+
- private
41+
description: __INLINED__
42+
inline:
43+
description:
44+
- an instance of the nested class example defined earlier.
45+
type: class_example::nested_class_example
46+
_static_member:
47+
description: __INLINED__
48+
inline:
49+
description:
50+
- static member variable.
51+
type: const int
52+
_x:
53+
annotation:
54+
- private
55+
description: __INLINED__
56+
inline:
57+
description:
58+
- some variable that holds an integer.
59+
type: int
60+
---

‎docs/libraries/classes.cpp/class_example/m_class_example.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: method
3+
title: class_example
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+
is_ctor: true
14+
overloads:
15+
class_example():
16+
annotation:
17+
- defaulted
18+
description: __INLINED__
19+
inline:
20+
description:
21+
- default constructor.
22+
signature_with_names: class_example()
23+
explicit class_example(int):
24+
arguments:
25+
- description: __OPTIONAL__
26+
name: x
27+
type: int
28+
description: __INLINED__
29+
inline:
30+
arguments:
31+
x:
32+
description: The one integer parameter this routine takes
33+
description:
34+
- an explicit constructor that takes a single `int`.
35+
signature_with_names: explicit class_example(int x)
36+
---

‎docs/libraries/classes.cpp/class_example/m_deprecated.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: method
3+
title: deprecated
4+
hyde:
5+
owner: __INLINED__
6+
brief: __INLINED__
7+
tags:
8+
- method
9+
inline:
10+
brief:
11+
- deprecated member function.
12+
owner: fosterbrereton
13+
defined_in_file: classes.cpp
14+
overloads:
15+
void deprecated(const std::string &, class_example *):
16+
annotation:
17+
- deprecated
18+
arguments:
19+
- description: __OPTIONAL__
20+
name: first
21+
type: const std::string &
22+
- description: __OPTIONAL__
23+
name: second
24+
type: class_example *
25+
description: __INLINED__
26+
inline:
27+
arguments:
28+
first:
29+
description: the first parameter
30+
second:
31+
description: the second parameter
32+
description:
33+
- deprecated member function.
34+
return: __OPTIONAL__
35+
signature_with_names: void deprecated(const std::string & first, class_example * second)
36+
---

‎docs/libraries/classes.cpp/class_example/m_deprecated_with_message.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: method
3+
title: deprecated_with_message
4+
hyde:
5+
owner: __INLINED__
6+
brief: __INLINED__
7+
tags:
8+
- method
9+
inline:
10+
brief:
11+
- deprecated member function that contains a compile-time deprecation message.
12+
owner: fosterbrereton
13+
defined_in_file: classes.cpp
14+
overloads:
15+
void deprecated_with_message(const std::string &, class_example *):
16+
annotation:
17+
- deprecated("example deprecation message")
18+
arguments:
19+
- description: __OPTIONAL__
20+
name: s
21+
type: const std::string &
22+
- description: __OPTIONAL__
23+
name: f
24+
type: class_example *
25+
description: __INLINED__
26+
inline:
27+
arguments:
28+
f:
29+
description: the second parameter
30+
s:
31+
description: the first parameter
32+
description:
33+
- deprecated member function that contains a compile-time deprecation message.
34+
return: __OPTIONAL__
35+
signature_with_names: void deprecated_with_message(const std::string & s, class_example * f)
36+
---

‎docs/libraries/classes.cpp/class_example/m_member_function.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: method
3+
title: member_function
4+
hyde:
5+
owner: __INLINED__
6+
brief: __INLINED__
7+
tags:
8+
- method
9+
inline:
10+
brief:
11+
- example member function.
12+
owner: fosterbrereton
13+
defined_in_file: classes.cpp
14+
overloads:
15+
int member_function():
16+
description: __INLINED__
17+
inline:
18+
description:
19+
- example member function.
20+
return: double the value of `_x`.
21+
return: __OPTIONAL__
22+
signature_with_names: int member_function()
23+
---

‎docs/libraries/classes.cpp/class_example/m_member_function_trailing_return_type.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: method
3+
title: member_function_trailing_return_type
4+
hyde:
5+
owner: __INLINED__
6+
brief: __INLINED__
7+
tags:
8+
- method
9+
inline:
10+
brief:
11+
- member function with a trailing return type.
12+
owner: fosterbrereton
13+
defined_in_file: classes.cpp
14+
overloads:
15+
auto member_function_trailing_return_type() const -> int:
16+
description: __INLINED__
17+
inline:
18+
description:
19+
- member function with a trailing return type.
20+
return: "\"`_x`\""
21+
return: __OPTIONAL__
22+
signature_with_names: auto member_function_trailing_return_type() const -> int
23+
---

‎docs/libraries/classes.cpp/class_example/m_overloaded.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
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

Comments
 (0)