Merge pull request #6392 from kenjis/fix-docs-link-to-func

kenjis · web-flow · commit 917b1502e8eb · 2022-08-19T19:19:25.000+09:00
docs: fix links to function/method
diff --git a/contributing/documentation.rst b/contributing/documentation.rst
@@ -124,6 +124,9 @@ To a URL
 To a Function
 =============
 
-    :php:func:`dot_array_search`
+    :php:func:`dot_array_search()`
 
-    :php:func:`Response::setCookie() <setCookie>`
+To a Method
+=============
+
+    :php:meth:`CodeIgniter\\HTTP\\Response::setCookie()`
diff --git a/user_guide_src/source/changelogs/v4.2.0.rst b/user_guide_src/source/changelogs/v4.2.0.rst
@@ -54,8 +54,8 @@ Behavior Changes
 - The color code output by :ref:`CLI::color() <cli-library-color>` has been changed to fix a bug.
 - To prevent unexpected access from the web browser, if a controller is added to a cli route (``$routes->cli()``), all methods of that controller are no longer accessible via auto-routing.
 - There is a possible backward compatibility break for those users extending the History Collector and they should probably update ``History::setFiles()`` method.
-- The :php:func:`dot_array_search`'s unexpected behavior has been fixed. Now ``dot_array_search('foo.bar.baz', ['foo' => ['bar' => 23]])`` returns ``null``. The previous versions returned ``23``.
-- The ``CodeIgniter::storePreviousURL()`` has been changed to store only the URLs whose Content-Type was ``text/html``. It also affects the behavior of :php:func:`previous_url` and :php:func:`redirect()->back() <redirect>`.
+- The :php:func:`dot_array_search()`'s unexpected behavior has been fixed. Now ``dot_array_search('foo.bar.baz', ['foo' => ['bar' => 23]])`` returns ``null``. The previous versions returned ``23``.
+- The ``CodeIgniter::storePreviousURL()`` has been changed to store only the URLs whose Content-Type was ``text/html``. It also affects the behavior of :php:func:`previous_url()` and :php:func:`redirect()->back() <redirect>`.
 
 Enhancements
 ************
@@ -97,8 +97,8 @@ Database
 Helpers and Functions
 =====================
 
-- HTML helper ``script_tag()`` now uses ``null`` values to write boolean attributes in minimized form: ``<script src="..." defer />``. See the sample code for :php:func:`script_tag`.
-- Added 4th parameter ``$includeDir`` to ``get_filenames()``. See :php:func:`get_filenames`.
+- HTML helper ``script_tag()`` now uses ``null`` values to write boolean attributes in minimized form: ``<script src="..." defer />``. See the sample code for :php:func:`script_tag()`.
+- Added 4th parameter ``$includeDir`` to ``get_filenames()``. See :php:func:`get_filenames()`.
 - Exception information logged through ``log_message()`` has now improved. It now includes the file and line where the exception originated. It also does not truncate the message anymore.
     - The log format has also changed. If users are depending on the log format in their apps, the new log format is "<1-based count> <cleaned filepath>(<line>): <class><function><args>"
 
diff --git a/user_guide_src/source/changelogs/v4.2.2.rst b/user_guide_src/source/changelogs/v4.2.2.rst
@@ -16,7 +16,7 @@ BREAKING
 - The method signature of ``CodeIgniter\Debug\Exceptions::__construct()`` has been changed. The ``IncomingRequest`` typehint on the ``$request`` parameter was removed. Extending classes should likewise remove the parameter so as not to break LSP.
 - The method signature of ``BaseBuilder.php::insert()`` and ``BaseBuilder.php::update()`` have been changed. The ``?array`` typehint on the ``$set`` parameter was removed.
 - A bug that caused pages to be cached before after filters were executed when using page caching has been fixed. Adding response headers or changing the response body in after filters now caches them correctly.
-- Due to a bug fix, now :php:func:`random_string` with the first parameter ``'crypto'`` throws ``InvalidArgumentException`` if the second parameter ``$len`` is an odd number.
+- Due to a bug fix, now :php:func:`random_string()` with the first parameter ``'crypto'`` throws ``InvalidArgumentException`` if the second parameter ``$len`` is an odd number.
 
 Changes
 *******
diff --git a/user_guide_src/source/cli/cli_commands.rst b/user_guide_src/source/cli/cli_commands.rst
@@ -90,7 +90,9 @@ The ``BaseCommand`` class that all commands must extend have a couple of helpful
 be familiar with when creating your own commands. It also has a :doc:`Logger </general/logging>` available at
 ``$this->logger``.
 
-.. php:class:: CodeIgniter\\CLI\\BaseCommand
+.. php:namespace:: CodeIgniter\CLI
+
+.. php:class:: BaseCommand
 
     .. php:method:: call(string $command[, array $params = []])
 
diff --git a/user_guide_src/source/database/results.rst b/user_guide_src/source/database/results.rst
@@ -239,7 +239,9 @@ true on success or false on failure.
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\Database\\BaseResult
+.. php:namespace:: CodeIgniter\Database
+
+.. php:class:: BaseResult
 
     .. php:method:: getResult([$type = 'object'])
 
diff --git a/user_guide_src/source/dbmgmt/forge.rst b/user_guide_src/source/dbmgmt/forge.rst
@@ -289,7 +289,9 @@ change the name, you can add a "name" key into the field defining array.
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\Database\\Forge
+.. php:namespace:: CodeIgniter\Database
+
+.. php:class:: Forge
 
     .. php:method:: addColumn($table[, $field = []])
 
diff --git a/user_guide_src/source/dbmgmt/migration.rst b/user_guide_src/source/dbmgmt/migration.rst
@@ -216,7 +216,9 @@ Preference                 Default                Options                    Des
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\Database\\MigrationRunner
+.. php:namespace:: CodeIgniter\Database
+
+.. php:class:: MigrationRunner
 
     .. php:method:: findMigrations()
 
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
@@ -348,7 +348,7 @@ Miscellaneous Functions
 
     .. note:: ``route_to()`` returns a route, not a full URI path for your site.
         If your **baseURL** contains sub folders, the return value is not the same
-        as the URI to link. In that case, just use :php:func:`url_to` instead.
+        as the URI to link. In that case, just use :php:func:`url_to()` instead.
 
 .. php:function:: service($name[, ...$params])
 
diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
@@ -37,7 +37,7 @@ The following functions are available:
     This helper function gives you friendlier syntax to set browser
     cookies. Refer to the :doc:`Response Library </outgoing/response>` for
     a description of its use, as this function is an alias for
-    :php:func:`Response::setCookie() <setCookie>`.
+    :php:meth:`CodeIgniter\\HTTP\\Response::setCookie()`.
 
 .. php:function:: get_cookie($index[, $xssClean = false[, $prefix = '']])
 
diff --git a/user_guide_src/source/incoming/message.rst b/user_guide_src/source/incoming/message.rst
@@ -34,7 +34,9 @@ This same negotiation can happen with four types of data:
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\HTTP\\Message
+.. php:namespace:: CodeIgniter\HTTP
+
+.. php:class:: Message
 
     .. php:method:: getBody()
 
diff --git a/user_guide_src/source/incoming/request.rst b/user_guide_src/source/incoming/request.rst
@@ -13,7 +13,9 @@ See the documentation for the :doc:`IncomingRequest Class </incoming/incomingreq
 Class Reference
 ===============
 
-.. php:class:: CodeIgniter\\HTTP\\Request
+.. php:namespace:: CodeIgniter\HTTP
+
+.. php:class:: Request
 
     .. php:method:: getIPAddress()
 
diff --git a/user_guide_src/source/installation/upgrade_422.rst b/user_guide_src/source/installation/upgrade_422.rst
@@ -28,7 +28,7 @@ Others
 
 - The method ``Forge::createTable()`` no longer executes a ``CREATE TABLE IF NOT EXISTS``.  When `$ifNotExists` is true, if the table is not found in ``$db->tableExists($table)`` then ``CREATE TABLE`` is executed.
 - The second parameter ``$ifNotExists`` of ``Forge::_createTable()`` is deprecated. It is no longer used and will be removed in a future release.
-- When you use :php:func:`random_string` with the first parameter ``'crypto'``, now if you set the second parameter ``$len`` to an odd number, ``InvalidArgumentException`` will be thrown. Change the parameter to an even number.
+- When you use :php:func:`random_string()` with the first parameter ``'crypto'``, now if you set the second parameter ``$len`` to an odd number, ``InvalidArgumentException`` will be thrown. Change the parameter to an even number.
 
 Breaking Enhancements
 *********************
diff --git a/user_guide_src/source/libraries/cookies.rst b/user_guide_src/source/libraries/cookies.rst
@@ -382,7 +382,7 @@ Class Reference
         :rtype: array
         :returns: Returns the array representation of the Cookie instance.
 
-.. php:class:: CodeIgniter\\HTTP\\Cookie\\CookieStore
+.. php:class:: CookieStore
 
     .. php:staticmethod:: fromCookieHeaders(array $headers[, bool $raw = false])
 
diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
@@ -214,7 +214,9 @@ Remember, that ``$config`` must be an instance of ``Config\Encryption`` class.
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\Encryption\\Encryption
+.. php:namespace:: CodeIgniter\Encryption
+
+.. php:class:: Encryption
 
     .. php:staticmethod:: createKey([$length = 32])
 
diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
@@ -43,7 +43,9 @@ is available:
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\HTTP\\UserAgent
+.. php:namespace:: CodeIgniter\HTTP
+
+.. php:class:: UserAgent
 
     .. php:method:: isBrowser([$key = null])
 
diff --git a/user_guide_src/source/outgoing/response.rst b/user_guide_src/source/outgoing/response.rst
@@ -247,7 +247,9 @@ The methods provided by the parent class that are available are:
 * :meth:`CodeIgniter\\HTTP\\Message::negotiateLanguage`
 * :meth:`CodeIgniter\\HTTP\\Message::negotiateLanguage`
 
-.. php:class:: CodeIgniter\\HTTP\\Response
+.. php:namespace:: CodeIgniter\HTTP
+
+.. php:class:: Response
 
     .. php:method:: getStatusCode()
 
diff --git a/user_guide_src/source/outgoing/table.rst b/user_guide_src/source/outgoing/table.rst
@@ -75,6 +75,8 @@ to the Table constructor:
 Class Reference
 ***************
 
+.. php:namespace:: CodeIgniter\View
+
 .. php:class:: Table
 
     .. attribute:: $function = null
diff --git a/user_guide_src/source/outgoing/view_parser.rst b/user_guide_src/source/outgoing/view_parser.rst
@@ -576,7 +576,9 @@ Result::
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\View\\Parser
+.. php:namespace:: CodeIgniter\View
+
+.. php:class:: Parser
 
     .. php:method:: render($view[, $options[, $saveData]])
 
diff --git a/user_guide_src/source/outgoing/view_renderer.rst b/user_guide_src/source/outgoing/view_renderer.rst
@@ -105,7 +105,9 @@ Several options can be passed to the ``render()`` or ``renderString()`` methods:
 Class Reference
 ***************
 
-.. php:class:: CodeIgniter\\View\\View
+.. php:namespace:: CodeIgniter\View
+
+.. php:class:: View
 
     .. php:method:: render($view[, $options[, $saveData = false]])
         :noindex:
