diff options
| author | nsfisis <nsfisis@gmail.com> | 2026-06-20 00:15:21 +0900 |
|---|---|---|
| committer | nsfisis <nsfisis@gmail.com> | 2026-06-20 00:15:21 +0900 |
| commit | 7c5162e7c2f9d466e96248b7482aa98350244e8b (patch) | |
| tree | 23290db5ebb3bea4f5f2c45dd9f148ca79f8c98e /crates/shirabe-external-packages/src/symfony/console/output | |
| parent | 08ad403ed366ac5839cb63333b5ba2c5007c655e (diff) | |
| download | php-shirabe-7c5162e7c2f9d466e96248b7482aa98350244e8b.tar.gz php-shirabe-7c5162e7c2f9d466e96248b7482aa98350244e8b.tar.zst php-shirabe-7c5162e7c2f9d466e96248b7482aa98350244e8b.zip | |
docs(console): fence PHP examples in doc comments as `php`
Ported docblocks embed PHP usage examples as indented (and bare-fenced)
code blocks, which rustdoc compiled as Rust doctests and failed
`cargo test`. Mark them as `php` so they render as code without being
run.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'crates/shirabe-external-packages/src/symfony/console/output')
| -rw-r--r-- | crates/shirabe-external-packages/src/symfony/console/output/console_output.rs | 10 | ||||
| -rw-r--r-- | crates/shirabe-external-packages/src/symfony/console/output/stream_output.rs | 8 |
2 files changed, 13 insertions, 5 deletions
diff --git a/crates/shirabe-external-packages/src/symfony/console/output/console_output.rs b/crates/shirabe-external-packages/src/symfony/console/output/console_output.rs index 8bd428d..0808fef 100644 --- a/crates/shirabe-external-packages/src/symfony/console/output/console_output.rs +++ b/crates/shirabe-external-packages/src/symfony/console/output/console_output.rs @@ -11,12 +11,16 @@ use crate::symfony::console::output::stream_output::StreamOutput; /// /// This class is a convenient wrapper around `StreamOutput` for both STDOUT and STDERR. /// -/// $output = new ConsoleOutput(); +/// ```php +/// $output = new ConsoleOutput(); +/// ``` /// /// This is equivalent to: /// -/// $output = new StreamOutput(fopen('php://stdout', 'w')); -/// $stdErr = new StreamOutput(fopen('php://stderr', 'w')); +/// ```php +/// $output = new StreamOutput(fopen('php://stdout', 'w')); +/// $stdErr = new StreamOutput(fopen('php://stderr', 'w')); +/// ``` #[derive(Debug)] pub struct ConsoleOutput { inner: StreamOutput, diff --git a/crates/shirabe-external-packages/src/symfony/console/output/stream_output.rs b/crates/shirabe-external-packages/src/symfony/console/output/stream_output.rs index 323135c..569b348 100644 --- a/crates/shirabe-external-packages/src/symfony/console/output/stream_output.rs +++ b/crates/shirabe-external-packages/src/symfony/console/output/stream_output.rs @@ -10,11 +10,15 @@ use crate::symfony::console::output::output_interface::VERBOSITY_NORMAL; /// /// Usage: /// -/// $output = new StreamOutput(fopen('php://stdout', 'w')); +/// ```php +/// $output = new StreamOutput(fopen('php://stdout', 'w')); +/// ``` /// /// As `StreamOutput` can use any stream, you can also use a file: /// -/// $output = new StreamOutput(fopen('/path/to/output.log', 'a', false)); +/// ```php +/// $output = new StreamOutput(fopen('/path/to/output.log', 'a', false)); +/// ``` #[derive(Debug)] pub struct StreamOutput { inner: Output, |
