diff --git a/docs/helper_classes.rst b/docs/helper_classes.rst new file mode 100644 index 0000000..8d724b5 --- /dev/null +++ b/docs/helper_classes.rst @@ -0,0 +1,73 @@ +Helper Classes +############## + +PathFactory +=========== + +``parse()`` +----------- + +.. code-block:: php + + resolveRelative($relativePath)->toString()`` is returned. + +``makeRelativePath()`` +---------------------- + +.. code-block:: php + + makeRelative($targetPath)->toString()`` is returned. diff --git a/docs/index.rst b/docs/index.rst index a5af700..5c5aad8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Documentation path_interfaces path_classes + helper_classes License ======= diff --git a/docs/path_classes.rst b/docs/path_classes.rst index 63f34c5..42025fb 100644 --- a/docs/path_classes.rst +++ b/docs/path_classes.rst @@ -7,12 +7,14 @@ RelativePath The only concrete implementation of ``RelativePathInterface``. In non-root relative paths first component returned by ``getComponents()`` is either ``'.'`` or ``'..'``. +When resolving relative, windows-ness of the resulting relative will be inherited from the base path. + Available constructors: .. code-block:: php