Fix readme and minor improvements for phpdoc (#198)

vjik · web-flow · commit c81f3b910528 · 2022-02-03T09:47:19.000+03:00
diff --git a/README.md b/README.md
@@ -40,22 +40,28 @@ The package provides two use cases for managing view templates:
 
 ### State of `View` and `WebView` services
 
-While being immutable and, by itself, stateless, both `View` and `WebView` services have sets of stateful and mutable data.
+While being immutable and, by itself, stateless, both `View` and `WebView` services have sets of stateful and mutable
+data.
 
 `View` service:
 - parameters,
-- blocks.
+- blocks,
+- theme,
+- language.
 
 `WebView` service:
 - parameters,
 - blocks,
+- theme,
+- language,
 - title,
 - meta and link tags,
 - JS/CSS strings,
 - JS/CSS files.
 
 The state of `View` and `WebView` is not cloned when the services are cloned. So when
-using `with*()`, both new and old instances are sharing the same set of stateful mutable data. It allows, for example, to get `WebView` via type-hinting in a controller and change context path:
+using `with*()`, both new and old instances are sharing the same set of stateful mutable data. It allows, for example,
+to get `WebView` via type-hinting in a controller and change context path:
 
 ```php
 final class BlogController {
diff --git a/src/Cache/CachedContent.php b/src/Cache/CachedContent.php
@@ -19,7 +19,7 @@
 use function strtr;
 
 /**
- * CacheContent caches content, supports the use of dynamic content {@see DynamicContent} inside cached content.
+ * `CacheContent` caches content, supports the use of dynamic content {@see DynamicContent} inside cached content.
  */
 final class CachedContent
 {
diff --git a/src/Cache/DynamicContent.php b/src/Cache/DynamicContent.php
@@ -5,7 +5,7 @@
 namespace Yiisoft\View\Cache;
 
 /**
- * DynamicContent generates data for dynamic content that is used for cached content {@see CachedContent}.
+ * `DynamicContent` generates data for dynamic content that is used for cached content {@see CachedContent}.
  */
 final class DynamicContent
 {
diff --git a/src/PhpTemplateRenderer.php b/src/PhpTemplateRenderer.php
@@ -15,7 +15,7 @@
 use function ob_start;
 
 /**
- * PhpTemplateRenderer renders the PHP views.
+ * `PhpTemplateRenderer` renders the PHP views.
  */
 final class PhpTemplateRenderer implements TemplateRendererInterface
 {
diff --git a/src/TemplateRendererInterface.php b/src/TemplateRendererInterface.php
@@ -5,7 +5,7 @@
 namespace Yiisoft\View;
 
 /**
- * TemplateRendererInterface is the interface that should be implemented by view template renderers.
+ * `TemplateRendererInterface` is the interface that should be implemented by view template renderers.
  */
 interface TemplateRendererInterface
 {
diff --git a/src/Theme.php b/src/Theme.php
@@ -16,7 +16,7 @@
 use function substr;
 
 /**
- * Theme represents an application theme.
+ * `Theme` represents an application theme.
  *
  * When {@see View} renders a view file, it will check the {@see View::$theme} to see if there is a themed
  * version of the view file exists. If so, the themed version will be rendered instead.
diff --git a/src/View.php b/src/View.php
@@ -18,9 +18,9 @@
 use function ob_start;
 
 /**
- * View represents an instance of a view for use in an any environment.
+ * `View` represents an instance of a view for use in an any environment.
  *
- * View provides a set of methods (e.g. {@see View::render()}) for rendering purpose.
+ * `View` provides a set of methods (e.g. {@see View::render()}) for rendering purpose.
  */
 final class View implements ViewInterface
 {
diff --git a/src/ViewContextInterface.php b/src/ViewContextInterface.php
@@ -5,7 +5,8 @@
 namespace Yiisoft\View;
 
 /**
- * ViewContextInterface is the interface that should be implemented by classes who want to support relative view names.
+ * `ViewContextInterface` is the interface that should be implemented by classes who want to support relative view
+ * names.
  *
  * The method {@see ViewContextInterface::getViewPath()} should be implemented to return the view path
  * that may be prefixed to a relative view name.
diff --git a/src/ViewTrait.php b/src/ViewTrait.php
@@ -26,7 +26,7 @@
 use function substr;
 
 /**
- * ViewTrait could be used as a base implementation of {@see ViewInterface}.
+ * `ViewTrait` could be used as a base implementation of {@see ViewInterface}.
  *
  * @internal
  */
diff --git a/src/WebView.php b/src/WebView.php
@@ -31,9 +31,9 @@
 use function strtr;
 
 /**
- * WebView represents an instance of a view for use in a WEB environment.
+ * `WebView` represents an instance of a view for use in a WEB environment.
  *
- * WebView provides a set of methods (e.g. {@see WebView::render()}) for rendering purpose.
+ * `WebView` provides a set of methods (e.g. {@see WebView::render()}) for rendering purpose.
  */
 final class WebView implements ViewInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`use function strtr;`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * CacheContent caches content, supports the use of dynamic content {@see DynamicContent} inside cached content.`
	`22`	+ * `CacheContent` caches content, supports the use of dynamic content {@see DynamicContent} inside cached content.
`23`	`23`	`*/`
`24`	`24`	`final class CachedContent`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Yiisoft\View\Cache;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * DynamicContent generates data for dynamic content that is used for cached content {@see CachedContent}.`
	`8`	+ * `DynamicContent` generates data for dynamic content that is used for cached content {@see CachedContent}.
`9`	`9`	`*/`
`10`	`10`	`final class DynamicContent`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`use function ob_start;`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * PhpTemplateRenderer renders the PHP views.`
	`18`	+ * `PhpTemplateRenderer` renders the PHP views.
`19`	`19`	`*/`
`20`	`20`	`final class PhpTemplateRenderer implements TemplateRendererInterface`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Yiisoft\View;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * TemplateRendererInterface is the interface that should be implemented by view template renderers.`
	`8`	+ * `TemplateRendererInterface` is the interface that should be implemented by view template renderers.
`9`	`9`	`*/`
`10`	`10`	`interface TemplateRendererInterface`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`use function substr;`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Theme represents an application theme.`
	`19`	+ * `Theme` represents an application theme.
`20`	`20`	`*`
`21`	`21`	`* When {@see View} renders a view file, it will check the {@see View::$theme} to see if there is a themed`
`22`	`22`	`* version of the view file exists. If so, the themed version will be rendered instead.`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,9 @@`
`18`	`18`	`use function ob_start;`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * View represents an instance of a view for use in an any environment.`
	`21`	+ * `View` represents an instance of a view for use in an any environment.
`22`	`22`	`*`
`23`		`- * View provides a set of methods (e.g. {@see View::render()}) for rendering purpose.`
	`23`	+ * `View` provides a set of methods (e.g. {@see View::render()}) for rendering purpose.
`24`	`24`	`*/`
`25`	`25`	`final class View implements ViewInterface`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@`
`5`	`5`	`namespace Yiisoft\View;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * ViewContextInterface is the interface that should be implemented by classes who want to support relative view names.`
	`8`	+ * `ViewContextInterface` is the interface that should be implemented by classes who want to support relative view
	`9`	`+ * names.`
`9`	`10`	`*`
`10`	`11`	`* The method {@see ViewContextInterface::getViewPath()} should be implemented to return the view path`
`11`	`12`	`* that may be prefixed to a relative view name.`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`use function substr;`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * ViewTrait could be used as a base implementation of {@see ViewInterface}.`
	`29`	+ * `ViewTrait` could be used as a base implementation of {@see ViewInterface}.
`30`	`30`	`*`
`31`	`31`	`* @internal`
`32`	`32`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,9 @@`
`31`	`31`	`use function strtr;`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * WebView represents an instance of a view for use in a WEB environment.`
	`34`	+ * `WebView` represents an instance of a view for use in a WEB environment.
`35`	`35`	`*`
`36`		`- * WebView provides a set of methods (e.g. {@see WebView::render()}) for rendering purpose.`
	`36`	+ * `WebView` provides a set of methods (e.g. {@see WebView::render()}) for rendering purpose.
`37`	`37`	`*/`
`38`	`38`	`final class WebView implements ViewInterface`
`39`	`39`	`{`