|
1 | 1 | # integration test |
2 | 2 |
|
3 | | - Code |
4 | | - roxygenise(path) |
5 | | - Message |
6 | | - i Loading testR6 |
7 | | - x classes.R:12: Must use one @param for each argument. |
8 | | - x $meth3(duplicate) is documented multiple times |
9 | | - x classes.R:12: Must use one @param for each argument. |
10 | | - x $meth3(missing) is not documented |
11 | | - x classes.R:12: Must use one @return per R6 method. |
12 | | - x classes.R:91: Undocumented R6 fields: field2 and undocumented_field. |
13 | | - x classes.R:91: R6 field documented multiple times: duplicatefield. |
14 | | - x classes.R:91: Unknown R6 field: nosuchfield. |
15 | | - x classes.R:91: Undocumented R6 active binding: undocumented_binding. |
16 | | - x classes.R:91: R6 active binding documented multiple times: duplicate_binding. |
17 | | - x classes.R:91: Undocumented R6 method: undocumented_method. |
18 | | - Writing 'NAMESPACE' |
19 | | - Writing 'A.Rd' |
20 | | - Writing 'B.Rd' |
21 | | - Writing 'C.Rd' |
22 | | - |
23 | | ---- |
24 | | - |
25 | 3 | Code |
26 | 4 | cat(read_lines(rd_file), sep = "\n") |
27 | 5 | Output |
|
31 | 9 | \alias{A} |
32 | 10 | \title{Class A} |
33 | 11 | \value{ |
34 | | - twice. |
35 | | - |
36 | | - really? |
| 12 | + A value. |
37 | 13 | } |
38 | 14 | \description{ |
39 | 15 | A method 1. |
40 | 16 | |
41 | 17 | Method 2 description. |
| 18 | + |
| 19 | + Method 3. |
42 | 20 | } |
43 | 21 | \details{ |
44 | 22 | Method 2 details. |
45 | | - |
46 | | - Method 3 details. |
47 | 23 | } |
48 | 24 | \examples{ |
49 | 25 | ## Example for meth1 |
|
79 | 55 | |
80 | 56 | \item{\code{active2}}{A binding 2.} |
81 | 57 | |
82 | | - \item{\code{active3}}{A binding 2.} |
| 58 | + \item{\code{active3}}{A binding 3.} |
83 | 59 | } |
84 | 60 | \if{html}{\out{</div>}} |
85 | 61 | } |
|
143 | 119 | Method 2 details. |
144 | 120 | } |
145 | 121 | |
| 122 | + \subsection{Returns}{ |
| 123 | + A value. |
| 124 | + } |
| 125 | + |
146 | 126 | \subsection{Examples}{ |
147 | 127 | \if{html}{\out{<div class="r example copy">}} |
148 | 128 | \preformatted{## Example for meth2 |
|
155 | 135 | \if{html}{\out{<a id="method-A-meth3"></a>}} |
156 | 136 | \if{latex}{\out{\hypertarget{method-A-meth3}{}}} |
157 | 137 | \subsection{Method \code{meth3()}}{ |
| 138 | + Method 3. |
158 | 139 | \subsection{Usage}{ |
159 | 140 | \if{html}{\out{<div class="r">}} |
160 | | - \preformatted{A$meth3(duplicate, missing)} |
| 141 | + \preformatted{A$meth3(x)} |
161 | 142 | \if{html}{\out{</div>}} |
162 | 143 | } |
163 | 144 | |
164 | 145 | \subsection{Arguments}{ |
165 | 146 | \if{html}{\out{<div class="arguments">}} |
166 | 147 | \describe{ |
167 | | - \item{\code{duplicate}}{This one is} |
168 | | - \item{\code{duplicate}}{Twice} |
| 148 | + \item{\code{x}}{An argument.} |
169 | 149 | } |
170 | 150 | \if{html}{\out{</div>}} |
171 | 151 | } |
172 | 152 | |
173 | | - \subsection{Details}{ |
174 | | - Method 3 details. |
175 | | - } |
176 | | - |
177 | | - \subsection{Returns}{ |
178 | | - twice. |
179 | | - } |
180 | | - |
181 | 153 | } |
182 | 154 | \if{html}{\out{<hr>}} |
183 | 155 | \if{html}{\out{<a id="method-A-clone"></a>}} |
|
214 | 186 | \description{ |
215 | 187 | B method 1. |
216 | 188 | |
217 | | - A method 4. |
| 189 | + B method 4. |
218 | 190 | } |
219 | 191 | \section{Super class}{ |
220 | 192 | \code{A} -> \code{B} |
|
277 | 249 | \if{html}{\out{<a id="method-B-meth4"></a>}} |
278 | 250 | \if{latex}{\out{\hypertarget{method-B-meth4}{}}} |
279 | 251 | \subsection{Method \code{meth4()}}{ |
280 | | - A method 4. |
| 252 | + B method 4. |
281 | 253 | \subsection{Usage}{ |
282 | 254 | \if{html}{\out{<div class="r">}} |
283 | 255 | \preformatted{B$meth4()} |
|
328 | 300 | \section{Public fields}{ |
329 | 301 | \if{html}{\out{<div class="r6-fields">}} |
330 | 302 | \describe{ |
331 | | - \item{\code{nosuchfield}}{This will warn.} |
| 303 | + \item{\code{field2}}{C field 2.} |
332 | 304 | |
333 | 305 | \item{\code{field5}}{C field 5.} |
334 | | - |
335 | | - \item{\code{duplicatefield}}{Multiple.} |
336 | | - |
337 | | - \item{\code{duplicatefield}}{times.} |
338 | 306 | } |
339 | 307 | \if{html}{\out{</div>}} |
340 | 308 | } |
341 | 309 | \section{Active bindings}{ |
342 | 310 | \if{html}{\out{<div class="r6-active-bindings">}} |
343 | 311 | \describe{ |
344 | | - \item{\code{nosuchfield}}{This will warn.} |
345 | | - |
346 | 312 | \item{\code{active2}}{C binding 2.} |
347 | 313 | |
348 | 314 | \item{\code{active4}}{C binding 4.} |
349 | 315 | |
350 | 316 | \item{\code{active6}}{C binding 6.} |
351 | | - |
352 | | - \item{\code{duplicate_binding}}{Double.} |
353 | | - |
354 | | - \item{\code{duplicate_binding}}{Double double.} |
355 | 317 | } |
356 | 318 | \if{html}{\out{</div>}} |
357 | 319 | } |
|
360 | 322 | \itemize{ |
361 | 323 | \item \href{#method-C-meth2}{\code{C$meth2()}} |
362 | 324 | \item \href{#method-C-meth5}{\code{C$meth5()}} |
363 | | - \item \href{#method-C-undocumented_method}{\code{C$undocumented_method()}} |
364 | 325 | } |
365 | 326 | } |
366 | 327 | \if{html}{\out{<details open><summary>Inherited methods</summary> |
|
402 | 363 | \if{html}{\out{</div>}} |
403 | 364 | } |
404 | 365 | |
405 | | - } |
406 | | - \if{html}{\out{<hr>}} |
407 | | - \if{html}{\out{<a id="method-C-undocumented_method"></a>}} |
408 | | - \if{latex}{\out{\hypertarget{method-C-undocumented_method}{}}} |
409 | | - \subsection{Method \code{undocumented_method()}}{ |
410 | | - \subsection{Usage}{ |
411 | | - \if{html}{\out{<div class="r">}} |
412 | | - \preformatted{C$undocumented_method()} |
413 | | - \if{html}{\out{</div>}} |
414 | | - } |
415 | | - |
416 | 366 | } |
417 | 367 | } |
418 | 368 |
|
0 commit comments