Skip to content

Commit a54870d

Browse files
committed
---
yaml --- r: 14743 b: refs/heads/try c: 9f4c0d7 h: refs/heads/master i: 14741: 1f0852b 14739: 2d5bf9a 14735: b3fce6b v: v3
1 parent 85f8aea commit a54870d

File tree

2 files changed

+74
-96
lines changed

2 files changed

+74
-96
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
refs/heads/master: 61b1875c16de39c166b0f4d54bba19f9c6777d1a
33
refs/heads/snap-stage1: e33de59e47c5076a89eadeb38f4934f58a3618a6
44
refs/heads/snap-stage3: 4a81779abd786ff22d71434c6d9a5917ea4cdfff
5-
refs/heads/try: e399263b5e9d726c0c1082d2092527067b9aadfe
5+
refs/heads/try: 9f4c0d71e521112e8113e552c06739440fb193d7
66
refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105

branches/try/src/rustdoc/demo.rs

Lines changed: 73 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -33,106 +33,94 @@ fn take_my_order_please(
3333
_order: [omnomnomy]
3434
) -> uint {
3535

36-
#[doc(
37-
desc = "OMG would you take my order already?",
38-
args(_waitress = "The waitress that you want to bother",
39-
_order = "The order vector. It should be filled with food."),
40-
return = "The price of the order, including tax",
41-
failure = "This function is full of fail"
42-
)];
36+
#[doc = "
37+
OMG would you take my order already?
4338
44-
fail;
45-
}
39+
# Arguments
4640
47-
fn take_my_order_now(
48-
_waitress: waitress,
49-
_order: [omnomnomy]
50-
) -> uint {
41+
* _waitress - The waitress that you want to bother
42+
* _order - The order vector. It should be filled with food
5143
52-
#[doc(
53-
desc = "OMG would you take my order already?",
54-
args(_waitress = "The waitress that you want to bother",
55-
_order = "The order vector. It should be filled with food."),
56-
return = "
44+
# Return
5745
58-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed
59-
nec molestie nisl. Duis massa risus, pharetra a scelerisque a,
60-
molestie eu velit. Donec mattis ligula at ante imperdiet ut
61-
dapibus mauris malesuada.
46+
The price of the order, including tax
6247
63-
Sed gravida nisi a metus elementum sit amet hendrerit dolor
64-
bibendum. Aenean sit amet neque massa, sed tempus tortor. Sed
65-
ut lobortis enim. Proin a mauris quis nunc fermentum ultrices
66-
eget a erat. Mauris in lectus vitae metus sodales
67-
auctor. Morbi nunc quam, ultricies at venenatis non,
68-
pellentesque ac dui.
48+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec
49+
molestie nisl. Duis massa risus, pharetra a scelerisque a,
50+
molestie eu velit. Donec mattis ligula at ante imperdiet ut
51+
dapibus mauris malesuada.
52+
53+
Sed gravida nisi a metus elementum sit amet hendrerit dolor
54+
bibendum. Aenean sit amet neque massa, sed tempus tortor. Sed ut
55+
lobortis enim. Proin a mauris quis nunc fermentum ultrices eget a
56+
erat. Mauris in lectus vitae metus sodales auctor. Morbi nunc
57+
quam, ultricies at venenatis non, pellentesque ac dui.
6958
70-
",
71-
failure = "This function is full of fail"
72-
)];
59+
# Failure
60+
61+
This function is full of fail
62+
"];
7363

7464
fail;
7565
}
7666

7767
mod fortress_of_solitude {
78-
#[doc(
79-
brief = "Superman's vacation home",
80-
desc = "
68+
#[doc = "
69+
Superman's vacation home
8170
82-
The fortress of solitude is located in the Arctic and it is
83-
cold. What you may not know about the fortress of solitude
84-
though is that it contains two separate bowling alleys. One of
85-
them features bumper-bowling and is kind of lame.
71+
The fortress of solitude is located in the Arctic and it is
72+
cold. What you may not know about the fortress of solitude
73+
though is that it contains two separate bowling alleys. One of
74+
them features bumper-bowling and is kind of lame.
8675
87-
Really, it's pretty cool.
76+
Really, it's pretty cool.
8877
89-
")];
78+
"];
9079

9180
}
9281

9382
mod blade_runner {
94-
#[doc(
95-
brief = "Blade Runner is probably the best movie ever",
96-
desc = "I like that in the world of Blade Runner it is always
97-
raining, and that it's always night time. And Aliens
98-
was also a really good movie.
99-
100-
Alien 3 was crap though."
101-
)];
102-
}
83+
#[doc = "
84+
Blade Runner is probably the best movie ever
10385
104-
#[doc(
105-
brief = "Bored",
106-
desc = "
86+
I like that in the world of Blade Runner it is always
87+
raining, and that it's always night time. And Aliens
88+
was also a really good movie.
10789
108-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec
109-
molestie nisl. Duis massa risus, pharetra a scelerisque a,
110-
molestie eu velit. Donec mattis ligula at ante imperdiet ut
111-
dapibus mauris malesuada. Sed gravida nisi a metus elementum sit
112-
amet hendrerit dolor bibendum. Aenean sit amet neque massa, sed
113-
tempus tortor. Sed ut lobortis enim. Proin a mauris quis nunc
114-
fermentum ultrices eget a erat. Mauris in lectus vitae metus
115-
sodales auctor. Morbi nunc quam, ultricies at venenatis non,
116-
pellentesque ac dui.
117-
118-
Quisque vitae est id eros placerat laoreet sit amet eu
119-
nisi. Curabitur suscipit neque porttitor est euismod
120-
lacinia. Curabitur non quam vitae ipsum adipiscing
121-
condimentum. Mauris ut ante eget metus sollicitudin
122-
blandit. Aliquam erat volutpat. Morbi sed nisl mauris. Nulla
123-
facilisi. Phasellus at mollis ipsum. Maecenas sed convallis
124-
sapien. Nullam in ligula turpis. Pellentesque a neque augue. Sed
125-
eget ante feugiat tortor congue auctor ac quis ante. Proin
126-
condimentum lacinia tincidunt.
127-
128-
")]
90+
Alien 3 was crap though.
91+
"];
92+
}
93+
94+
#[doc = "
95+
Bored
96+
97+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec
98+
molestie nisl. Duis massa risus, pharetra a scelerisque a,
99+
molestie eu velit. Donec mattis ligula at ante imperdiet ut
100+
dapibus mauris malesuada. Sed gravida nisi a metus elementum sit
101+
amet hendrerit dolor bibendum. Aenean sit amet neque massa, sed
102+
tempus tortor. Sed ut lobortis enim. Proin a mauris quis nunc
103+
fermentum ultrices eget a erat. Mauris in lectus vitae metus
104+
sodales auctor. Morbi nunc quam, ultricies at venenatis non,
105+
pellentesque ac dui.
106+
107+
Quisque vitae est id eros placerat laoreet sit amet eu
108+
nisi. Curabitur suscipit neque porttitor est euismod
109+
lacinia. Curabitur non quam vitae ipsum adipiscing
110+
condimentum. Mauris ut ante eget metus sollicitudin
111+
blandit. Aliquam erat volutpat. Morbi sed nisl mauris. Nulla
112+
facilisi. Phasellus at mollis ipsum. Maecenas sed convallis
113+
sapien. Nullam in ligula turpis. Pellentesque a neque augue. Sed
114+
eget ante feugiat tortor congue auctor ac quis ante. Proin
115+
condimentum lacinia tincidunt.
116+
117+
"]
129118
resource bored(bored: bool) {
130119
log(error, bored);
131120
}
132121

133-
#[doc(
134-
brief = "The Shunned House",
135-
desc = "
122+
#[doc = "
123+
The Shunned House
136124
137125
From even the greatest of horrors irony is seldom absent. Sometimes it
138126
enters directly into the composition of the events, while sometimes it
@@ -147,11 +135,9 @@ northward along the same street to Mrs. Whitman's home and the
147135
neighboring hillside churchyard of St. John's, whose hidden expanse of
148136
Eighteenth Century gravestones had for him a peculiar fascination.
149137
150-
")]
138+
"]
151139
iface the_shunned_house {
152-
#[doc(
153-
desc = "
154-
140+
#[doc = "
155141
Now the irony is this. In this walk, so many times repeated, the
156142
world's greatest master of the terrible and the bizarre was
157143
obliged to pass a particular house on the eastern side of the
@@ -165,17 +151,14 @@ iface the_shunned_house {
165151
unknowingly, and stands starkly leering as a symbol of all that is
166152
unutterably hideous.
167153
168-
",
169-
args(
170-
a =
171-
"A yard dating from a time when the region was partly
172-
open country"
173-
))]
174-
fn dingy_house(unkempt_yard: int);
154+
# Arguments
175155
176-
#[doc(
177-
desc = "
156+
* unkempt_yard - A yard dating from a time when the region was partly
157+
open country
158+
"]
159+
fn dingy_house(unkempt_yard: int);
178160

161+
#[doc = "
179162
The house was--and for that matter still is--of a kind to attract
180163
the attention of the curious. Originally a farm or semi-farm
181164
building, it followed the average New England colonial lines of
@@ -191,17 +174,12 @@ iface the_shunned_house {
191174
the graveyards of the first settlers, and straightened only when
192175
the removal of the bodies to the North Burial Ground made it
193176
decently possible to cut through the old family plots.
194-
195-
",
196-
return = "A dingy house with an unkempt yard",
197-
failure = "Will fail if bodies are removed from premises"
198-
)]
177+
"]
199178
fn construct() -> bool;
200179
}
201180

202181
#[doc = "Whatever"]
203182
impl of the_shunned_house for omnomnomy {
204-
#[doc(args(_unkempt_yard = "Whatever"))]
205183
fn dingy_house(_unkempt_yard: int) {
206184
}
207185

0 commit comments

Comments
 (0)