aboutsummaryrefslogtreecommitdiffhomepage
path: root/crates/shirabe-external-packages/src
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2026-06-20 00:15:21 +0900
committernsfisis <nsfisis@gmail.com>2026-06-20 00:15:21 +0900
commit7c5162e7c2f9d466e96248b7482aa98350244e8b (patch)
tree23290db5ebb3bea4f5f2c45dd9f148ca79f8c98e /crates/shirabe-external-packages/src
parent08ad403ed366ac5839cb63333b5ba2c5007c655e (diff)
downloadphp-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')
-rw-r--r--crates/shirabe-external-packages/src/symfony/console/input/argv_input.rs8
-rw-r--r--crates/shirabe-external-packages/src/symfony/console/input/array_input.rs4
-rw-r--r--crates/shirabe-external-packages/src/symfony/console/input/string_input.rs4
-rw-r--r--crates/shirabe-external-packages/src/symfony/console/output/console_output.rs10
-rw-r--r--crates/shirabe-external-packages/src/symfony/console/output/stream_output.rs8
5 files changed, 25 insertions, 9 deletions
diff --git a/crates/shirabe-external-packages/src/symfony/console/input/argv_input.rs b/crates/shirabe-external-packages/src/symfony/console/input/argv_input.rs
index a292a52..80105e9 100644
--- a/crates/shirabe-external-packages/src/symfony/console/input/argv_input.rs
+++ b/crates/shirabe-external-packages/src/symfony/console/input/argv_input.rs
@@ -12,13 +12,17 @@ use shirabe_php_shim::PhpMixed;
///
/// Usage:
///
-/// $input = new ArgvInput();
+/// ```php
+/// $input = new ArgvInput();
+/// ```
///
/// By default, the `$_SERVER['argv']` array is used for the input values.
///
/// This can be overridden by explicitly passing the input values in the constructor:
///
-/// $input = new ArgvInput($_SERVER['argv']);
+/// ```php
+/// $input = new ArgvInput($_SERVER['argv']);
+/// ```
///
/// If you pass it yourself, don't forget that the first element of the array
/// is the name of the running application.
diff --git a/crates/shirabe-external-packages/src/symfony/console/input/array_input.rs b/crates/shirabe-external-packages/src/symfony/console/input/array_input.rs
index 6f3f596..1c17480 100644
--- a/crates/shirabe-external-packages/src/symfony/console/input/array_input.rs
+++ b/crates/shirabe-external-packages/src/symfony/console/input/array_input.rs
@@ -12,7 +12,9 @@ use shirabe_php_shim::PhpMixed;
///
/// Usage:
///
-/// $input = new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']);
+/// ```php
+/// $input = new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']);
+/// ```
///
/// PHP arrays can mix integer and string keys; `parameters` preserves both the
/// key type (`PhpMixed::Int` / `PhpMixed::String`) and the insertion order.
diff --git a/crates/shirabe-external-packages/src/symfony/console/input/string_input.rs b/crates/shirabe-external-packages/src/symfony/console/input/string_input.rs
index 4dbc4e1..e04e519 100644
--- a/crates/shirabe-external-packages/src/symfony/console/input/string_input.rs
+++ b/crates/shirabe-external-packages/src/symfony/console/input/string_input.rs
@@ -11,7 +11,9 @@ use shirabe_php_shim::{CaptureKey, PhpMixed};
///
/// Usage:
///
-/// $input = new StringInput('foo --bar="foobar"');
+/// ```php
+/// $input = new StringInput('foo --bar="foobar"');
+/// ```
#[derive(Debug, Clone)]
pub struct StringInput {
pub(crate) inner: ArgvInput,
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,