yard: add page (#10486)

* yard: add page
2023-07-13 07:57:04 +00:00
parent 75f6b62e8c
commit 65b53bd0ba
1 changed files with 16 additions and 0 deletions
--- a/pages/common/yard.md
+++ b/pages/common/yard.md
@@ -0,0 +1,16 @@
+# yard
+
+> Documentation tool for Ruby.
+> More information: <https://yardoc.org/>.
+
+- Create the documentation:
+
+`yard`
+
+- Create the documentation and save it to one file:
+
+`yard --one-file`
+
+- List all undocumented objects:
+
+`yard stats --list-undoc`