admin/mruby-mruby
1
0
Fork 0
mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix word case: yard -> YARD

Browse Source 
https://yardoc.org/
This commit is contained in:
John Bampton
2023-04-04 18:20:02 +10:00
parent b44d757b8c
commit 7082e95fa2
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -53,7 +53,7 @@ See the [compile.md](doc/guides/compile.md) file for the detail.
## Building documentation
There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen and Graphviz)
There are two sets of documentation in mruby: the mruby API (generated by YARD) and C API (Doxygen and Graphviz)
To build both of them, simply go
tasks/doc.rake
+1 -1
View File
@@ -9,7 +9,7 @@ namespace :doc do
begin
sh "mrbdoc"
rescue
puts "ERROR: To generate yard documentation, you should install yard-mruby gem."
puts "ERROR: To generate YARD documentation, you should install yard-mruby gem."
puts " $ gem install yard-mruby yard-coderay"
puts "https://yardoc.org/"
puts "https://rubygems.org/gems/yard-mruby"