document tools.apple_dot_clean (closes #977) (#978)

conan-io · Dec 18, 2018 · d7e1f2f · d7e1f2f
1 parent 025bbe5
commit d7e1f2f
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/reference/tools.rst b/reference/tools.rst
@@ -1494,3 +1494,18 @@ tools.latest_vs_version_installed()
 
 Returns a string with the major version of latest Microsoft Visual Studio available on machine. If no Microsoft Visual Studio installed,
 it returns ``None``.
+
+
+tools.apple_dot_clean()
+-----------------------
+
+.. code-block:: python
+
+    def apple_dot_clean(folder)
+
+Remove recursively all ``._`` files inside ``folder`` containing metadata information for Apple
+operating systems, these files can appear when unzipping a file that has been created in Macos.
+This tool will remove only files matching the pattern if there is file without the prefix too.
+
+Parameters:
+    - **folder** (Required): root folder to start deleting ``._`` files.